Class GatewayClientConfiguration

Namespace

NetCord.Gateway

Assembly

NetCord.dll

public class GatewayClientConfiguration

Inheritance

object

GatewayClientConfiguration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GatewayClientConfiguration()

public GatewayClientConfiguration()

Properties

Cache

The cache for the GatewayClient. Defaults to GatewayClientCache.

public IGatewayClientCache? Cache { get; init; }

Property Value

IGatewayClientCache

Compression

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

public IGatewayCompression? Compression { get; init; }

Property Value

IGatewayCompression

ConnectionProperties

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

public ConnectionPropertiesProperties? ConnectionProperties { get; init; }

Property Value

ConnectionPropertiesProperties

DefaultPayloadProperties

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

public WebSocketPayloadProperties? DefaultPayloadProperties { get; init; }

Property Value

WebSocketPayloadProperties

Hostname

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

public string? Hostname { get; init; }

Property Value

string

Intents

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

public GatewayIntents? Intents { get; init; }

Property Value

GatewayIntents?

LargeThreshold

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 int? LargeThreshold { get; init; }

Property Value

int?

LatencyTimer

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

public ILatencyTimer? LatencyTimer { get; init; }

Property Value

ILatencyTimer

Presence

The presence properties for the GatewayClient. Defaults to null.

public PresenceProperties? Presence { get; init; }

Property Value

PresenceProperties

RateLimiterProvider

The provider for WebSocket rate limiters. Defaults to GatewayRateLimiterProvider.

public IRateLimiterProvider? RateLimiterProvider { get; init; }

Property Value

IRateLimiterProvider

ReconnectStrategy

The strategy for reconnecting the WebSocket. Defaults to ReconnectStrategy.

public IReconnectStrategy? ReconnectStrategy { get; init; }

Property Value

IReconnectStrategy

RestClientConfiguration

The configuration for the RestClient at Rest. Defaults to null.

public RestClientConfiguration? RestClientConfiguration { get; init; }

Property Value

RestClientConfiguration

Shard

The shard for the GatewayClient. Defaults to null.

public Shard? Shard { get; init; }

Property Value

Shard?

Version

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

public ApiVersion? Version { get; init; }

Property Value

ApiVersion?

WebSocketConnectionProvider

The provider for creating WebSocket connections. Defaults to WebSocketConnectionProvider.

public IWebSocketConnectionProvider? WebSocketConnectionProvider { get; init; }

Property Value

IWebSocketConnectionProvider