Class AbstractKinveyClientRequest<T>
This is a client request to be sent to Kinvey
Inheritance
Namespace: Kinvey
Assembly: Kinvey.dll
Syntax
public abstract class AbstractKinveyClientRequest<T> : object
Type Parameters
Name | Description |
---|---|
T | The type of Kinvey client request and response. |
Constructors
| Improve this Doc View SourceAbstractKinveyClientRequest(AbstractClient, String, String, Object, Dictionary<String, String>)
Declaration
protected AbstractKinveyClientRequest(AbstractClient client, string requestMethod, string uriTemplate, Object httpContent, Dictionary<string, string> uriParameters)
Parameters
Type | Name | Description |
---|---|---|
AbstractClient | client | |
System.String | requestMethod | |
System.String | uriTemplate | |
Object | httpContent | |
Dictionary<System.String, System.String> | uriParameters |
AbstractKinveyClientRequest(AbstractClient, String, String, String, Object, Dictionary<String, String>)
Declaration
protected AbstractKinveyClientRequest(AbstractClient client, string baseURL, string requestMethod, string uriTemplate, Object httpContent, Dictionary<string, string> uriParameters)
Parameters
Type | Name | Description |
---|---|---|
AbstractClient | client | |
System.String | baseURL | |
System.String | requestMethod | |
System.String | uriTemplate | |
Object | httpContent | |
Dictionary<System.String, System.String> | uriParameters |
Fields
| Improve this Doc View Sourceclient
The Kinvey Client which created this request.
Declaration
protected readonly AbstractClient client
Field Value
Type | Description |
---|---|
AbstractClient | The object of the class inherited from AbstractClient. |
requestMethod
The request method.
Declaration
protected readonly string requestMethod
Field Value
Type | Description |
---|---|
System.String | The string value containing a request method. |
uriResourceParameters
The URI resource parameters.
Declaration
public Dictionary<string, string> uriResourceParameters
Field Value
Type | Description |
---|---|
Dictionary<System.String, System.String> | The dictionary type value containing resource parameters for uri. |
uriTemplate
The URI template.
Declaration
public string uriTemplate
Field Value
Type | Description |
---|---|
System.String | The string value containing uri template. |
Properties
| Improve this Doc View SourceAppKey
Gets or sets the app key.
Declaration
public string AppKey { get; set; }
Property Value
Type | Description |
---|---|
System.String | The app key. |
Client
Gets the client.
Declaration
public AbstractClient Client { get; }
Property Value
Type | Description |
---|---|
AbstractClient | The client. |
customRequestHeaders
Custom headers for the request.
Declaration
public JObject customRequestHeaders { get; set; }
Property Value
Type | Description |
---|---|
JObject | The customRequestHeaders property gets/sets the value of the JObject field, _customRequestHeaders. |
HttpContent
Gets or sets the content of the http.
Declaration
public Object HttpContent { get; set; }
Property Value
Type | Description |
---|---|
Object | The content of the http. |
LastResponseCode
Gets the last response code.
Declaration
public HttpStatusCode LastResponseCode { get; }
Property Value
Type | Description |
---|---|
HttpStatusCode | The last response code. |
LastResponseHeaders
Gets the last response headers.
Declaration
public List<KeyValuePair<string, IEnumerable<string>>> LastResponseHeaders { get; }
Property Value
Type | Description |
---|---|
List<KeyValuePair<System.String, IEnumerable<System.String>>> | The last response headers. |
LastResponseMessage
Gets the last response message.
Declaration
public string LastResponseMessage { get; }
Property Value
Type | Description |
---|---|
System.String | The last response message. |
OverrideRedirect
Should the request intercept redirects and route them to an override
Declaration
public bool OverrideRedirect { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The OverrideRedirect property gets/sets the value of the bool type. If the value is |
PayloadType
The type of payload
Declaration
public AbstractKinveyClientRequest<T>.RequestPayloadType PayloadType { get; set; }
Property Value
Type | Description |
---|---|
AbstractKinveyClientRequest.RequestPayloadType<> | The type of the payload. |
RequestAuth
Gets or sets the request authenticator.
Declaration
public IAuthenticator RequestAuth { get; set; }
Property Value
Type | Description |
---|---|
IAuthenticator | The request auth. |
RequestHeaders
Gets or sets the request headers.
Declaration
public List<KeyValuePair<string, IEnumerable<string>>> RequestHeaders { get; set; }
Property Value
Type | Description |
---|---|
List<KeyValuePair<System.String, IEnumerable<System.String>>> | The request headers. |
RequestMethod
Gets the request method.
Declaration
public string RequestMethod { get; }
Property Value
Type | Description |
---|---|
System.String | The request method. |
RequestStartTime
Start time of the request.
Declaration
public string RequestStartTime { get; set; }
Property Value
Type | Description |
---|---|
System.String | The string value containing the start time of the request. |
RequireAppCredentials
Gets or sets a value indicating whether this
Declaration
public bool RequireAppCredentials { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
Methods
| Improve this Doc View SourceBuildRestRequest()
Builds the rest request.
Declaration
public HttpRequestMessage BuildRestRequest()
Returns
Type | Description |
---|---|
HttpRequestMessage | The rest request. |
Execute()
Executes this request synchronously.
Declaration
public virtual T Execute()
Returns
Type | Description |
---|---|
T | The type of response. |
ExecuteAsync()
Executes this request asynchronously.
Declaration
public virtual Task<T> ExecuteAsync()
Returns
Type | Description |
---|---|
Task<T> | The async task with the type of the response. |
ExecuteUnparsed()
Executes the request without any parsing.
Declaration
public HttpResponseMessage ExecuteUnparsed()
Returns
Type | Description |
---|---|
HttpResponseMessage | The unparsed. |
ExecuteUnparsedAsync()
Executes the request asynchronously without any parsing.
Declaration
public Task<HttpResponseMessage> ExecuteUnparsedAsync()
Returns
Type | Description |
---|---|
Task<HttpResponseMessage> | The async task with Http response. |
onRedirectAsync(String)
Redirects the request to a new location.
Declaration
public virtual Task<T> onRedirectAsync(String newLocation)
Parameters
Type | Name | Description |
---|---|---|
String | newLocation | New location |
Returns
Type | Description |
---|---|
Task<T> | The async task with the type of the response. |