Class RequestOptions

Namespace

Kook

Assembly

Kook.Net.Core.dll

表示发送请求时要使用的选项。

public class RequestOptions

Inheritance

object

RequestOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RequestOptions()

使用默认设置创建一个新的 RequestOptions 类的实例。

public RequestOptions()

Remarks

默认的请求超时时间是 DefaultRequestTimeout。

Properties

AuditLogReason

获取或设置要写入到服务器审计日志中的操作原因。

public string? AuditLogReason { get; set; }

Property Value

string

Remarks

默认的 API 客户端不支持设置此属性。

CancellationToken

获取或设置此请求的取消令牌。

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

Default

使用默认设置创建一个新的 RequestOptions 类的实例。

public static RequestOptions Default { get; }

Property Value

RequestOptions

Remarks

默认的请求超时时间是 DefaultRequestTimeout。

RatelimitCallback

获取或设置此请求触发速率限制时要执行的回调委托。

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

Property Value

Func<IRateLimitInfo, Task>

See Also

DefaultRatelimitCallback

RetryMode

获取或设置请求失败时的重试行为；如果为 null，则使用配置的默认的重试行为。

public RetryMode? RetryMode { get; set; }

Property Value

RetryMode?

See Also

DefaultRetryMode

Timeout

获取或设置等待此请求完成的最大时间，以毫秒为单位。

public int? Timeout { get; set; }

Property Value

int?

Remarks

获取或设置等待此请求完成的最大时间，以毫秒为单位。如果为 null，则请求不会超时。 如果此请求的桶触发了速率限制并且在超时前不会恢复，此请求将立即失败。

Methods

Clone()

Creates a shallow copy of the current object.

public RequestOptions Clone()

Returns

RequestOptions

A shallow copy of the current object.