ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Discord.WebSocket.DiscordSocketConfig.html
goat 0a227fd2b7 docs: regenerate
2020-03-24 03:22:08 +09:00

687 lines
36 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class DiscordSocketConfig
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class DiscordSocketConfig
">
<meta name="generator" content="docfx 2.48.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Discord.WebSocket.DiscordSocketConfig">
<h1 id="Discord_WebSocket_DiscordSocketConfig" data-uid="Discord.WebSocket.DiscordSocketConfig" class="text-break">Class DiscordSocketConfig
</h1>
<div class="markdown level0 summary"><p>Represents a configuration class for <a class="xref" href="Discord.WebSocket.DiscordSocketClient.html">DiscordSocketClient</a>.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Discord.DiscordConfig.html">DiscordConfig</a></div>
<div class="level2"><a class="xref" href="Discord.Rest.DiscordRestConfig.html">DiscordRestConfig</a></div>
<div class="level3"><span class="xref">DiscordSocketConfig</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Discord.Rest.DiscordRestConfig.html#Discord_Rest_DiscordRestConfig_RestClientProvider">DiscordRestConfig.RestClientProvider</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_APIVersion">DiscordConfig.APIVersion</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_VoiceAPIVersion">DiscordConfig.VoiceAPIVersion</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_Version">DiscordConfig.Version</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_UserAgent">DiscordConfig.UserAgent</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_APIUrl">DiscordConfig.APIUrl</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_CDNUrl">DiscordConfig.CDNUrl</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_InviteUrl">DiscordConfig.InviteUrl</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_DefaultRequestTimeout">DiscordConfig.DefaultRequestTimeout</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxMessageSize">DiscordConfig.MaxMessageSize</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxMessagesPerBatch">DiscordConfig.MaxMessagesPerBatch</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">DiscordConfig.MaxUsersPerBatch</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxGuildsPerBatch">DiscordConfig.MaxGuildsPerBatch</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUserReactionsPerBatch">DiscordConfig.MaxUserReactionsPerBatch</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxAuditLogEntriesPerBatch">DiscordConfig.MaxAuditLogEntriesPerBatch</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_DefaultRetryMode">DiscordConfig.DefaultRetryMode</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_LogLevel">DiscordConfig.LogLevel</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_RateLimitPrecision">DiscordConfig.RateLimitPrecision</a>
</div>
<div>
<a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_UseSystemClock">DiscordConfig.UseSystemClock</a>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.WebSocket.html">Discord.WebSocket</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.WebSocket.dll</h6>
<h5 id="Discord_WebSocket_DiscordSocketConfig_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class DiscordSocketConfig : DiscordRestConfig</code></pre>
</div>
<h5 id="Discord_WebSocket_DiscordSocketConfig_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks"><p>This configuration, based on <a class="xref" href="Discord.Rest.DiscordRestConfig.html">DiscordRestConfig</a>, helps determine several key configurations the
socket client depend on. For instance, shards and connection timeout.</p>
</div>
<h5 id="Discord_WebSocket_DiscordSocketConfig_examples"><strong>Examples</strong></h5>
<p>The following config enables the message cache and configures the client to always download user upon guild
availability.</p>
<pre><code class="lang-cs">var config = new DiscordSocketConfig
{
AlwaysDownloadUsers = true,
MessageCacheSize = 100
};
var client = new DiscordSocketClient(config);</code></pre>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig__ctor.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L130">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig__ctor_" data-uid="Discord.WebSocket.DiscordSocketConfig.#ctor*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig__ctor" data-uid="Discord.WebSocket.DiscordSocketConfig.#ctor">DiscordSocketConfig()</h4>
<div class="markdown level1 summary"><p>Initializes a default configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DiscordSocketConfig()</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_GatewayEncoding.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.GatewayEncoding%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L31">View Source</a>
</span>
<h4 id="Discord_WebSocket_DiscordSocketConfig_GatewayEncoding" data-uid="Discord.WebSocket.DiscordSocketConfig.GatewayEncoding">GatewayEncoding</h4>
<div class="markdown level1 summary"><p>Returns the encoding gateway should use.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string GatewayEncoding = &quot;json&quot;</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L103">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers_" data-uid="Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers" data-uid="Discord.WebSocket.DiscordSocketConfig.AlwaysDownloadUsers">AlwaysDownloadUsers</h4>
<div class="markdown level1 summary"><p>Gets or sets whether or not all users should be downloaded as guilds come available.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool AlwaysDownloadUsers { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>
By default, the Discord gateway will only send offline members if a guild has less than a certain number
of members (determined by <a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_LargeThreshold">LargeThreshold</a> in this library). This behaviour is why
sometimes a user may be missing from the WebSocket cache for collections such as
<a class="xref" href="Discord.WebSocket.SocketGuild.html#Discord_WebSocket_SocketGuild_Users">Users</a>.
</p>
<p>
This property ensures that whenever a guild becomes available (determined by
<a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_GuildAvailable">GuildAvailable</a>), incomplete user chunks will be
downloaded to the WebSocket cache.
</p>
<p>
For more information, please see
<a href="https://discordapp.com/developers/docs/topics/gateway#request-guild-members">Request Guild Members</a>
on the official Discord API documentation.
</p>
<div class="NOTE"><h5>note</h5><p>
Please note that it can be difficult to fill the cache completely on large guilds depending on the
traffic. If you are using the command system, the default user TypeReader may fail to find the user
due to this issue. This may be resolved at v3 of the library. Until then, you may want to consider
overriding the TypeReader and use
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetUserAsync_System_UInt64_Discord_RequestOptions_">GetUserAsync(UInt64, RequestOptions)</a>
or <a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetGuildUserAsync_System_UInt64_System_UInt64_Discord_RequestOptions_">GetGuildUserAsync(UInt64, UInt64, RequestOptions)</a>
as a backup.
</p></div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_ConnectionTimeout.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.ConnectionTimeout%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L42">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_ConnectionTimeout_" data-uid="Discord.WebSocket.DiscordSocketConfig.ConnectionTimeout*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_ConnectionTimeout" data-uid="Discord.WebSocket.DiscordSocketConfig.ConnectionTimeout">ConnectionTimeout</h4>
<div class="markdown level1 summary"><p>Gets or sets the time, in milliseconds, to wait for a connection to complete before aborting.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ConnectionTimeout { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_ExclusiveBulkDelete.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.ExclusiveBulkDelete%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L120">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_ExclusiveBulkDelete_" data-uid="Discord.WebSocket.DiscordSocketConfig.ExclusiveBulkDelete*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_ExclusiveBulkDelete" data-uid="Discord.WebSocket.DiscordSocketConfig.ExclusiveBulkDelete">ExclusiveBulkDelete</h4>
<div class="markdown level1 summary"><p>Gets or sets the behavior for <a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_MessageDeleted">MessageDeleted</a> on bulk deletes.</p>
<p>If true, the <a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_MessageDeleted">MessageDeleted</a> event will not be raised for bulk deletes, and
only the <a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_MessagesBulkDeleted">MessagesBulkDeleted</a> will be raised.</p>
<p>If false, both events will be raised.</p>
<p>If unset, both events will be raised, but a warning will be raised the first time a bulk delete event is received.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool? ExclusiveBulkDelete { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_GatewayHost.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.GatewayHost%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L37">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_GatewayHost_" data-uid="Discord.WebSocket.DiscordSocketConfig.GatewayHost*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_GatewayHost" data-uid="Discord.WebSocket.DiscordSocketConfig.GatewayHost">GatewayHost</h4>
<div class="markdown level1 summary"><p>Gets or sets the WebSocket host to connect to. If <code>null</code>, the client will use the
/gateway endpoint.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string GatewayHost { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_GuildSubscriptions.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.GuildSubscriptions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L125">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_GuildSubscriptions_" data-uid="Discord.WebSocket.DiscordSocketConfig.GuildSubscriptions*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_GuildSubscriptions" data-uid="Discord.WebSocket.DiscordSocketConfig.GuildSubscriptions">GuildSubscriptions</h4>
<div class="markdown level1 summary"><p>Gets or sets enabling dispatching of guild subscription events e.g. presence and typing events.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool GuildSubscriptions { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_HandlerTimeout.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.HandlerTimeout%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L108">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_HandlerTimeout_" data-uid="Discord.WebSocket.DiscordSocketConfig.HandlerTimeout*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_HandlerTimeout" data-uid="Discord.WebSocket.DiscordSocketConfig.HandlerTimeout">HandlerTimeout</h4>
<div class="markdown level1 summary"><p>Gets or sets the timeout for event handlers, in milliseconds, after which a warning will be logged. Null
disables this check.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int? HandlerTimeout { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_LargeThreshold.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.LargeThreshold%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L62">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_LargeThreshold_" data-uid="Discord.WebSocket.DiscordSocketConfig.LargeThreshold*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_LargeThreshold" data-uid="Discord.WebSocket.DiscordSocketConfig.LargeThreshold">LargeThreshold</h4>
<div class="markdown level1 summary"><p>Gets or sets the max number of users a guild may have for offline users to be included in the READY
packet. Max is 250.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int LargeThreshold { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_MessageCacheSize.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.MessageCacheSize%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L57">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_MessageCacheSize_" data-uid="Discord.WebSocket.DiscordSocketConfig.MessageCacheSize*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_MessageCacheSize" data-uid="Discord.WebSocket.DiscordSocketConfig.MessageCacheSize">MessageCacheSize</h4>
<div class="markdown level1 summary"><p>Gets or sets the number of messages per channel that should be kept in cache. Setting this to zero
disables the message cache entirely.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int MessageCacheSize { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_ShardId.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.ShardId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L47">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_ShardId_" data-uid="Discord.WebSocket.DiscordSocketConfig.ShardId*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_ShardId" data-uid="Discord.WebSocket.DiscordSocketConfig.ShardId">ShardId</h4>
<div class="markdown level1 summary"><p>Gets or sets the ID for this shard. Must be less than <a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_TotalShards">TotalShards</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int? ShardId { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_TotalShards.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.TotalShards%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L51">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_TotalShards_" data-uid="Discord.WebSocket.DiscordSocketConfig.TotalShards*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_TotalShards" data-uid="Discord.WebSocket.DiscordSocketConfig.TotalShards">TotalShards</h4>
<div class="markdown level1 summary"><p>Gets or sets the total number of shards for this application.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int? TotalShards { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_UdpSocketProvider.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.UdpSocketProvider%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L71">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_UdpSocketProvider_" data-uid="Discord.WebSocket.DiscordSocketConfig.UdpSocketProvider*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_UdpSocketProvider" data-uid="Discord.WebSocket.DiscordSocketConfig.UdpSocketProvider">UdpSocketProvider</h4>
<div class="markdown level1 summary"><p>Gets or sets the provider used to generate new UDP sockets.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public UdpSocketProvider UdpSocketProvider { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Net.Udp.UdpSocketProvider.html">UdpSocketProvider</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig_WebSocketProvider.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig.WebSocketProvider%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L67">View Source</a>
</span>
<a id="Discord_WebSocket_DiscordSocketConfig_WebSocketProvider_" data-uid="Discord.WebSocket.DiscordSocketConfig.WebSocketProvider*"></a>
<h4 id="Discord_WebSocket_DiscordSocketConfig_WebSocketProvider" data-uid="Discord.WebSocket.DiscordSocketConfig.WebSocketProvider">WebSocketProvider</h4>
<div class="markdown level1 summary"><p>Gets or sets the provider used to generate new WebSocket connections.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public WebSocketProvider WebSocketProvider { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Net.WebSockets.WebSocketProvider.html">WebSocketProvider</a></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_DiscordSocketConfig.md&amp;value=---%0Auid%3A%20Discord.WebSocket.DiscordSocketConfig%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/DiscordSocketConfig.cs/#L26" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink