Class HttpClientConnection

Carry out HTTP connection using HttpClient

Inheritance
Object
HttpClientConnection
Implements
Inherited Members
Namespace: Pixiv.VroidSdk.Networking.Connections
Assembly: Pixiv.VroidSdk.dll
Syntax
public sealed class HttpClientConnection : IHttpConnection

Constructors

HttpClientConnection(HttpClient, IHttpUrl, IHttpHeader, SynchronizationContext)

コンストラクタ

Declaration
public HttpClientConnection(HttpClient client, IHttpUrl url, IHttpHeader header, SynchronizationContext context)
Parameters
Type Name Description
HttpClient client

HTTP接続クライアント
IHttpUrl url

接続先URL
IHttpHeader header

リクエストHTTPヘッダ
SynchronizationContext context

コールバックを呼び出す際のSynchronizationContext

Properties

Header

HTTP request header

Declaration
public IHttpHeader Header { get; set; }
Property Value
Type Description
IHttpHeader

OnDownloadProgressChanged

Callback on download progression

Declaration
public Action<float> OnDownloadProgressChanged { get; set; }
Property Value
Type Description
Action<Single>

OnUploadProgressChanged

Callback on upload progression

Declaration
public Action<float> OnUploadProgressChanged { get; set; }
Property Value
Type Description
Action<Single>

Param

HTTP request parameter

Declaration
public IHttpParam Param { get; set; }
Property Value
Type Description
IHttpParam

Url

URL

Declaration
public IHttpUrl Url { get; }
Property Value
Type Description
IHttpUrl

Methods

BuildUrl()

Return URL containing query parameter

Declaration
public string BuildUrl()
Returns
Type Description
String

URL string

DeleteAsync()

Carry out DELETE request

Declaration
public Task<IHttpResponse> DeleteAsync()
Returns
Type Description
Task<IHttpResponse>

DELETE request response
Exceptions
Type Condition
HttpRequestFailedException

HTTP request failure

DeleteAsync(Action<IHttpResponse>, Action<HttpRequestFailedException>)

Carry out DELETE request

Declaration
public void DeleteAsync(Action<IHttpResponse> onSuccess, Action<HttpRequestFailedException> onError)
Parameters
Type Name Description
Action<IHttpResponse> onSuccess

Callback on success
Action<HttpRequestFailedException> onError

Callback on failure

GetAsync()

Carry out GET request

Declaration
public Task<IHttpResponse> GetAsync()
Returns
Type Description
Task<IHttpResponse>

GET request response
Exceptions
Type Condition
HttpRequestFailedException

HTTP request failure

GetAsync(Action<IHttpResponse>, Action<HttpRequestFailedException>)

Carry out GET request

Declaration
public void GetAsync(Action<IHttpResponse> onSuccess, Action<HttpRequestFailedException> onError)
Parameters
Type Name Description
Action<IHttpResponse> onSuccess

Callback on success
Action<HttpRequestFailedException> onError

Callback on failure

PostAsync()

Cary out Post request

Declaration
public Task<IHttpResponse> PostAsync()
Returns
Type Description
Task<IHttpResponse>

Post request response
Exceptions
Type Condition
HttpRequestFailedException

HTTP request failure

PostAsync(Action<IHttpResponse>, Action<HttpRequestFailedException>)

Carry out POST request

Declaration
public void PostAsync(Action<IHttpResponse> onSuccess, Action<HttpRequestFailedException> onError)
Parameters
Type Name Description
Action<IHttpResponse> onSuccess

Callback on success
Action<HttpRequestFailedException> onError

Callback on failure

PutAsync()

Carry out PUT request

Declaration
public Task<IHttpResponse> PutAsync()
Returns
Type Description
Task<IHttpResponse>

PUT request response
Exceptions
Type Condition
HttpRequestFailedException

HTTP request failure

PutAsync(Action<IHttpResponse>, Action<HttpRequestFailedException>)

Carry out PUT request

Declaration
public void PutAsync(Action<IHttpResponse> onSuccess, Action<HttpRequestFailedException> onError)
Parameters
Type Name Description
Action<IHttpResponse> onSuccess

Callback on success
Action<HttpRequestFailedException> onError

Callback on failure

Implements