Class KookConfig

Namespace

Kook

Assembly

Kook.Net.Core.dll

Defines various behaviors of Kook.Net.

public class KookConfig

Inheritance

object

KookConfig

Derived

KookRestConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

APIUrl

Returns the base Kook API URL.

public static readonly string APIUrl

Field Value

string

The Kook API URL using APIVersion.

APIVersion

Returns the API version Kook.Net uses.

public const int APIVersion = 3

Field Value

int

An int representing the API version that Kook.Net uses to communicate with Kook.

A list of available API version can be seen on the official Kook API documentation .

BoostPackDuration

Returns the duration of a Kook boost pack.

public static readonly TimeSpan BoostPackDuration

Field Value

TimeSpan

DefaultRequestTimeout

Returns the default timeout for requests.

public const int DefaultRequestTimeout = 6000

Field Value

int

The amount of time it takes in milliseconds before a request is timed out.

MaxIntimacyScore

Returns the max value for a Kook intimacy score.

public const int MaxIntimacyScore = 2200

Field Value

int

The maximum value of an intimacy score allowed by Kook.

MaxItemsPerBatchByDefault

Returns the max items allowed to be in a request by default.

public const int MaxItemsPerBatchByDefault = 100

Field Value

int

The maximum number of items that can be gotten per-batch by default.

MaxMessageSize

Returns the max length for a Kook message.

public const int MaxMessageSize = 20000

Field Value

int

The maximum length of a message allowed by Kook.

Remarks

warning

The accurate value of this property is not known. It is set to int.MaxValue at current so that it does not work.

MaxMessagesPerBatch

Returns the max messages allowed to be in a request.

public const int MaxMessagesPerBatch = 50

Field Value

int

The maximum number of messages that can be gotten per-batch.

MaxNicknameSize

Returns the max length for a Kook guild nickname.

public const int MaxNicknameSize = 64

Field Value

int

The maximum length of a nickname allowed by Kook.

MaxUsersPerBatch

Returns the max users allowed to be in a request.

public const int MaxUsersPerBatch = 50

Field Value

int

The maximum number of users that can be gotten per-batch.

MinIntimacyScore

Returns the min value for a Kook intimacy score.

public const int MinIntimacyScore = 0

Field Value

int

The minimum value of an intimacy score allowed by Kook.

MinNicknameSize

Returns the min length for a Kook guild nickname.

public const int MinNicknameSize = 2

Field Value

int

The minimum length of a nickname allowed by Kook.

VoiceAPIVersion

Returns the Voice API version Kook.Net uses.

public const int VoiceAPIVersion = 1

Field Value

int

An int representing the API version that Kook.Net uses to communicate with KOOK's voice server.

Properties

AcceptLanguage

Gets the accept language that Kook.Net uses in its clients.

public string AcceptLanguage { get; set; }

Property Value

string

The accept language used in each Kook.Net request.

DefaultRatelimitCallback

Gets or sets the default callback for rate limits.

public Func<IRateLimitInfo, Task>? DefaultRatelimitCallback { get; set; }

Property Value

Func<IRateLimitInfo, Task>

Remarks

This property is mutually exclusive with RatelimitCallback.

DefaultRetryMode

Gets or sets how a request should act in the case of an error, by default.

public RetryMode DefaultRetryMode { get; set; }

Property Value

RetryMode

The currently set RetryMode.

FormatUsersInBidirectionalUnicode

Gets or sets if the Rest/Socket user ToString() override formats the string in respect to bidirectional unicode.

public bool FormatUsersInBidirectionalUnicode { get; set; }

Property Value

bool

Remarks

By default, the returned value will be "?Kook?#1234", to work with bidirectional usernames.
If set to false, this value will be "Kook#1234".

LogLevel

Gets or sets the minimum log level severity that will be sent to the Log event.

public LogSeverity LogLevel { get; set; }

Property Value

LogSeverity

The currently set LogSeverity for logging level.

UserAgent

Gets the user agent that Kook.Net uses in its clients.

public static string UserAgent { get; }

Property Value

string

The user agent used in each Kook.Net request.

Version

Gets the Kook.Net version, including the build number.

public static string Version { get; }

Property Value

string

A string containing the detailed version information, including its build number; Unknown when the version fails to be fetched.