Interface IRestClient

Namespace

Kook.Net.Rest

Assembly

Kook.Net.Core.dll

表示一个通用的基于 RESTful API 的客户端。

public interface IRestClient : IDisposable

Inherited Members

IDisposable.Dispose()

Methods

SendAsync(HttpMethod, string, IReadOnlyDictionary<string, object>, CancellationToken, string?, IEnumerable<KeyValuePair<string, IEnumerable<string>>>?)

发送一个带有多部分数据参数的 RESTful API 请求。

Task<RestResponse> SendAsync(HttpMethod method, string endpoint, IReadOnlyDictionary<string, object> multipartParams, CancellationToken cancellationToken, string? reason = null, IEnumerable<KeyValuePair<string, IEnumerable<string>>>? requestHeaders = null)

Parameters

method HttpMethod

用于发送此请求的方法。

endpoint string

要发送此请求的端点。

multipartParams IReadOnlyDictionary<string, object>

要发送的多部分数据参数。

cancellationToken CancellationToken

用于取消任务的取消令牌。

reason string

用于审计日志的操作原因。

requestHeaders IEnumerable<KeyValuePair<string, IEnumerable<string>>>

要随请求一起发送的附加标头。

Returns

Task<RestResponse>

表示一个异步发送操作的任务。任务的结果包含请求的响应。

SendAsync(HttpMethod, string, string, CancellationToken, string?, IEnumerable<KeyValuePair<string, IEnumerable<string>>>?)

发送一个带有 JSON 请求体的 RESTful API 请求。

Task<RestResponse> SendAsync(HttpMethod method, string endpoint, string json, CancellationToken cancellationToken, string? reason = null, IEnumerable<KeyValuePair<string, IEnumerable<string>>>? requestHeaders = null)

Parameters

method HttpMethod

用于发送此请求的方法。

endpoint string

要发送此请求的端点。

json string

要发送的 JSON 请求体。

cancellationToken CancellationToken

用于取消任务的取消令牌。

reason string

用于审计日志的操作原因。

requestHeaders IEnumerable<KeyValuePair<string, IEnumerable<string>>>

要随请求一起发送的附加标头。

Returns

Task<RestResponse>

表示一个异步发送操作的任务。任务的结果包含请求的响应。

SendAsync(HttpMethod, string, CancellationToken, string?, IEnumerable<KeyValuePair<string, IEnumerable<string>>>?)

发送一个 RESTful API 请求。

Task<RestResponse> SendAsync(HttpMethod method, string endpoint, CancellationToken cancellationToken, string? reason = null, IEnumerable<KeyValuePair<string, IEnumerable<string>>>? requestHeaders = null)

Parameters

method HttpMethod

用于发送此请求的方法。

endpoint string

要发送此请求的端点。

cancellationToken CancellationToken

用于取消任务的取消令牌。

reason string

用于审计日志的操作原因。

requestHeaders IEnumerable<KeyValuePair<string, IEnumerable<string>>>

要随请求一起发送的附加标头。

Returns

Task<RestResponse>

表示一个异步发送操作的任务。任务的结果包含请求的响应。

SetCancellationToken(CancellationToken)

设置此客户端的取消令牌。

void SetCancellationToken(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

用于取消任务的取消令牌。

SetHeader(string, string?)

设置此客户端的 HTTP 头部，这将应用于所有请求。

void SetHeader(string key, string? value)

Parameters

key string

HTTP 头部的键。

value string

HTTP 头部的值。