Class RequestOptions

Namespace

Glitch9.IO.Networking.RESTApi

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

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()

Extension Methods

LogExtensions.LogIfNotSetInInspector<T>(T, string, string)

LogExtensions.LogIfNull<T>(T, string, string)

LogExtensions.LogIfSetInInspector<T>(T, string, string)

SystemExtensions.ToSenderName(object)

TypeExtensions.IsInteger(object)

Properties

Id

The identifier of the request.

public string Id { get; set; }

Property Value

string

IgnoreLogs

If this is set, the request will not log any information.

public bool IgnoreLogs { get; set; }

Property Value

bool

MIMEType

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

public virtual MIMEType MIMEType { get; set; }

Property Value

MIMEType

MaxRetry

The number of retries of the request. Default is 3

public int MaxRetry { get; set; }

Property Value

int

OutputAudioFormat

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

public AudioFormat OutputAudioFormat { get; set; }

Property Value

AudioFormat

OutputPath

The directory path where the file will be downloaded.

public string OutputPath { get; set; }

Property Value

string

RetryDelayInSec

Seconds of delay to make a retry. Default is 1

public float RetryDelayInSec { get; set; }

Property Value

float

Sender

The local sender of the request.

public string Sender { get; set; }

Property Value

string

StreamHandler

If this is set, it means you are requesting a stream response from the server.

public IStreamHandler StreamHandler { get; set; }

Property Value

IStreamHandler

Timeout

The custom timeout for the request.

public TimeSpan? Timeout { get; set; }

Property Value

TimeSpan?

Token

Optional. External cancellation token for the request.

public CancellationToken? Token { get; set; }

Property Value

CancellationToken?