Skip to main content

Class RequestOptions

Represents options that should be used when sending a request.

Assembly: Discord.Net.Core.dll​
View Source​
Declaration
public class RequestOptions

Properties​

Default​

Creates a new Discord.RequestOptions class with its default settings.

View Source​
Declaration
public static RequestOptions Default { get; }

Timeout​

Gets or sets the maximum time to wait for this request to complete.

View Source​
Declaration
public int? Timeout { get; set; }

CancelToken​

Gets or sets the cancellation token for this request.

View Source​
Declaration
public CancellationToken CancelToken { get; set; }

RetryMode​

Gets or sets the retry behavior when the request fails.

View Source​
Declaration
public RetryMode? RetryMode { get; set; }

HeaderOnly​

View Source​
Declaration
public bool HeaderOnly { get; }

AuditLogReason​

Gets or sets the reason for this action in the guild's audit log.

View Source​
Declaration
public string AuditLogReason { get; set; }

UseSystemClock​

Gets or sets whether or not this request should use the system clock for rate-limiting. Defaults to true.

View Source​
Declaration
public bool? UseSystemClock { get; set; }

RatelimitCallback​

Gets or sets the callback to execute regarding ratelimits for this request.

View Source​
Declaration
public Func<IRateLimitInfo, Task> RatelimitCallback { get; set; }

Methods​

Clone()​

View Source​
Declaration
public RequestOptions Clone()
Returns​

Discord.RequestOptions