Class ApiRequestOptions

A container for generalized request inputs. This type allows consumers to extend the request functionality by abstracting away from the default (built-in) request framework (e.g. RestSharp).

Inheritance

object

ApiRequestOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Unity.Services.Apis.Shared

Assembly: solution.dll

Syntax

public class ApiRequestOptions

Constructors

ApiRequestOptions()

Constructs a new instance of ApiRequestOptions

Declaration

public ApiRequestOptions()

Properties

Data

Any data associated with a request body.

Declaration

public object Data { get; set; }

Property Value

Type	Description
object

FileParameters

File parameters to be sent along with the request.

Declaration

public Multimap<string, Stream> FileParameters { get; set; }

Property Value

Type	Description
Multimap<string, Stream>

FormParameters

Form parameters to be sent along with the request.

Declaration

public Dictionary<string, string> FormParameters { get; set; }

Property Value

Type	Description
Dictionary<string, string>

HeaderParameters

Header parameters to be applied to to the request. Keys may have 1 or more values associated.

Declaration

public Multimap<string, string> HeaderParameters { get; set; }

Property Value

Type	Description
Multimap<string, string>

Operation

Operation associated with the request path.

Declaration

public string Operation { get; set; }

Property Value

Type	Description
string

PathParameters

Parameters to be bound to path parts of the Request's URL

Declaration

public Dictionary<string, string> PathParameters { get; set; }

Property Value

Type	Description
Dictionary<string, string>

QueryParameters

Query parameters to be applied to the request. Keys may have 1 or more values associated.

Declaration

public Multimap<string, string> QueryParameters { get; set; }

Property Value

Type	Description
Multimap<string, string>