Class ShardedGatewayClientConfiguration

Namespace

NetCord.Gateway

Assembly

NetCord.dll

public class ShardedGatewayClientConfiguration

Inheritance

object

ShardedGatewayClientConfiguration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ShardedGatewayClientConfiguration()

public ShardedGatewayClientConfiguration()

Properties

CacheProviderFactory

The cache provider for the GatewayClient. Defaults to Empty.

public Func<Shard, IGatewayClientCacheProvider?>? CacheProviderFactory { get; init; }

Property Value

Func<Shard, IGatewayClientCacheProvider>

CompressionFactory

The compression provider for the GatewayClient. Defaults to ZstandardGatewayCompression if available, otherwise ZLibGatewayCompression.

public Func<Shard, IGatewayCompression?>? CompressionFactory { get; init; }

Property Value

Func<Shard, IGatewayCompression>

ConnectionPropertiesFactory

The properties for the connection of the GatewayClient. Defaults to null.

public Func<Shard, ConnectionPropertiesProperties?>? ConnectionPropertiesFactory { get; init; }

Property Value

Func<Shard, ConnectionPropertiesProperties>

DefaultPayloadPropertiesFactory

The default payload properties for WebSocket payloads. Defaults to null.

public Func<Shard, WebSocketPayloadProperties?>? DefaultPayloadPropertiesFactory { get; init; }

Property Value

Func<Shard, WebSocketPayloadProperties>

Hostname

The hostname to use for the GatewayClient. Defaults to GatewayHostname.

public string? Hostname { get; init; }

Property Value

string

IntentsFactory

The intents to use for the GatewayClient. Defaults to AllNonPrivileged.

public Func<Shard, GatewayIntents?>? IntentsFactory { get; init; }

Property Value

Func<Shard, GatewayIntents?>

LargeThresholdFactory

The large threshold for the GatewayClient. Value between 50 and 250, total number of guild users where the gateway will stop sending offline guild users in the guild user list. Defaults to 50.

public Func<Shard, int?>? LargeThresholdFactory { get; init; }

Property Value

Func<Shard, int?>

LatencyTimerFactory

The latency timer for tracking latency of the WebSocket connection. Defaults to LatencyTimer.

public Func<Shard, ILatencyTimer?>? LatencyTimerFactory { get; init; }

Property Value

Func<Shard, ILatencyTimer>

LoggerFactory

The logger for the GatewayClient. Defaults to NullLogger. The Shard argument is null for the RestClient's logger.

public Func<Shard?, IGatewayLogger?>? LoggerFactory { get; init; }

Property Value

Func<Shard?, IGatewayLogger>

MaxConcurrency

The maximum number of shards that can connect concurrently. If null, it will be determined by Discord.

public int? MaxConcurrency { get; init; }

Property Value

int?

PresenceFactory

The presence properties for the GatewayClient. Defaults to null.

public Func<Shard, PresenceProperties?>? PresenceFactory { get; init; }

Property Value

Func<Shard, PresenceProperties>

RateLimiterProviderFactory

The provider for WebSocket rate limiters. Defaults to GatewayRateLimiterProvider.

public Func<Shard, IRateLimiterProvider?>? RateLimiterProviderFactory { get; init; }

Property Value

Func<Shard, IRateLimiterProvider>

ReconnectStrategyFactory

The strategy for reconnecting the WebSocket. Defaults to ReconnectStrategy.

public Func<Shard, IReconnectStrategy?>? ReconnectStrategyFactory { get; init; }

Property Value

Func<Shard, IReconnectStrategy>

RestClientConfiguration

The configuration for the RestClient at Rest and for each shard at Rest. Defaults to null.

public RestClientConfiguration? RestClientConfiguration { get; init; }

Property Value

RestClientConfiguration

ShardRange

The range of shards to use. Note that shard IDs are zero-based and the end value is exclusive. For example, to use shards 2, 3, and 4, set this to 2..5. If null, all shards from 0 to TotalShardCount - 1 will be used.

public Range? ShardRange { get; init; }

Property Value

Range?

Remarks

TotalShardCount is required to be set when this property is set.

TotalShardCount

The total number of shards. If null, the number of shards will be determined by Discord.

public int? TotalShardCount { get; init; }

Property Value

int?

VersionFactory

The version of the Discord Gateway to use. Defaults to V10.

public Func<Shard, ApiVersion?>? VersionFactory { get; init; }

Property Value

Func<Shard, ApiVersion?>

WebSocketConnectionProviderFactory

The provider for creating WebSocket connections. Defaults to WebSocketConnectionProvider.

public Func<Shard, IWebSocketConnectionProvider?>? WebSocketConnectionProviderFactory { get; init; }

Property Value

Func<Shard, IWebSocketConnectionProvider>