|
- using System.Threading;
-
- namespace Discord
- {
- /// <summary>
- /// Represents options that should be used when sending a request.
- /// </summary>
- public class RequestOptions
- {
- /// <summary>
- /// Creates a new <see cref="RequestOptions" /> class with its default settings.
- /// </summary>
- public static RequestOptions Default => new RequestOptions();
-
- /// <summary>
- /// Gets or set the max time, in milliseconds, to wait for this request to complete. If
- /// <c>null</c>, a request will not time out. If a rate limit has been triggered for this
- /// request's bucket and will not be unpaused in time, this request will fail immediately.
- /// </summary>
- public int? Timeout { get; set; }
- public CancellationToken CancelToken { get; set; } = CancellationToken.None;
- /// <summary>
- /// Gets or sets the retry behavior when the request fails.
- /// </summary>
- public RetryMode? RetryMode { get; set; }
- public bool HeaderOnly { get; internal set; }
- /// <summary>
- /// Gets or sets the reason for this action in the guild's audit log.
- /// </summary>
- /// <remarks>
- /// Gets or sets the reason that will be written to the guild's audit log if applicable. This may not apply
- /// to all actions.
- /// </remarks>
- public string AuditLogReason { get; set; }
-
- internal bool IgnoreState { get; set; }
- internal string BucketId { get; set; }
- internal bool IsClientBucket { get; set; }
-
- internal static RequestOptions CreateOrClone(RequestOptions options)
- {
- if (options == null)
- return new RequestOptions();
- else
- return options.Clone();
- }
-
- /// <summary>
- /// Initializes a new <see cref="RequestOptions" /> class with the default request timeout set in
- /// <see cref="DiscordConfig" />.
- /// </summary>
- public RequestOptions()
- {
- Timeout = DiscordConfig.DefaultRequestTimeout;
- }
-
- public RequestOptions Clone() => MemberwiseClone() as RequestOptions;
- }
- }
|