Class RequestOptions

Options for RESTRequest and RESTRequest<T>. This class is used to set the parameters for the http request.

Inheritance
object
RequestOptions
Inherited Members
Namespace: Glitch9.IO.Networking.RESTApi
Assembly: Glitch9.IO.dll
Syntax
public sealed class RequestOptions

Properties

| Edit this page View Source

CancellationToken

Optional. External cancellation token for the request.

Declaration
public CancellationToken CancellationToken { get; set; }
Property Value
Type Description
CancellationToken
| Edit this page View Source

ContentType

Optional. The content type of the request. Default is Json

Declaration
public MimeType ContentType { get; set; }
Property Value
Type Description
MimeType
| Edit this page View Source

Context

Optional. Arbitrary context data associated with the request.

Declaration
public object Context { get; set; }
Property Value
Type Description
object
| Edit this page View Source

DisableAwsSigV4

If true, disables AWS Signature Version 4 signing for the request.

Declaration
public bool DisableAwsSigV4 { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

DownloadOptions

The directory path where the file will be downloaded.

Declaration
public DownloadOptions DownloadOptions { get; set; }
Property Value
Type Description
DownloadOptions
| Edit this page View Source

JssOverride

Optional. The JsonSerializerSettings override for this request.

Declaration
public JsonSerializerSettings JssOverride { get; set; }
Property Value
Type Description
JsonSerializerSettings
| Edit this page View Source

LogOptions

Overrides the log level for the request.

Declaration
public CurlLogOptions LogOptions { get; set; }
Property Value
Type Description
CurlLogOptions
| Edit this page View Source

MaxRetryCount

Overrides the client max retry count for the request.

Declaration
public int? MaxRetryCount { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

MaxRetryDelaySeconds

Overrides the client max retry delay in seconds for the request.

Declaration
public float? MaxRetryDelaySeconds { get; set; }
Property Value
Type Description
float?
| Edit this page View Source

OnContextCaptured

Optional. Invoked by the HTTP layer after the request body has been serialized and the final endpoint URL has been resolved. Subscribe to capture the finalized CurlContext regardless of what Wire model is sent.

Declaration
public Action<CurlContext> OnContextCaptured { get; set; }
Property Value
Type Description
Action<CurlContext>
| Edit this page View Source

OutputAudioFormat

Optional. The audio format of the request. Default is null.

Declaration
public AudioFormat OutputAudioFormat { get; set; }
Property Value
Type Description
AudioFormat
| Edit this page View Source

PollHandler

Optional. The poll handler for handling polling results.

Declaration
public IPollHandler PollHandler { get; set; }
Property Value
Type Description
IPollHandler
| Edit this page View Source

RetryDelaySeconds

Overrides the client retry delay in seconds for the request.

Declaration
public float? RetryDelaySeconds { get; set; }
Property Value
Type Description
float?
| Edit this page View Source

Sender

The local sender of the request.

Declaration
public string Sender { get; set; }
Property Value
Type Description
string
| Edit this page View Source

StreamOptions

Optional. The streaming options for handling streaming responses.

Declaration
public StreamOptions StreamOptions { get; set; }
Property Value
Type Description
StreamOptions
| Edit this page View Source

Timeout

Overrides the client timeout for the request.

Declaration
public TimeSpan? Timeout { get; set; }
Property Value
Type Description
TimeSpan?

Extension Methods