Table of Contents

Class KookSocketRestClient

Namespace
Kook.WebSocket
Assembly
Kook.Net.WebSocket.dll

表示一个用于网关客户端内的 REST 客户端。

public class KookSocketRestClient : KookRestClient, IKookClient, IDisposable
Inheritance
KookSocketRestClient
Implements
Inherited Members
Extension Methods

Methods

LoginAsync(TokenType, string, bool)

登录到 KOOK API。

public Task LoginAsync(TokenType tokenType, string token, bool validateToken = true)

Parameters

tokenType TokenType

要使用的令牌类型。

token string

要使用的令牌。

validateToken bool

是否验证令牌。

Returns

Task

一个表示异步登录操作的任务。

Remarks

验证令牌的操作是通过 ValidateToken(TokenType, string) 方法完成的。
此方法用于向当前客户端设置后续 API 请求的身份验证信息,获取并设置当前所登录用户的信息。

Exceptions

NotSupportedException

网关客户端内的 REST 客户端无法进行登录或退出登录。

LogoutAsync()

从 KOOK API 退出登录。

public Task LogoutAsync()

Returns

Task

一个表示异步退出登录操作的任务。

Remarks

此方法用于清除当前客户端的身份验证信息及所缓存的当前所登录的用户信息。

Exceptions

NotSupportedException

网关客户端内的 REST 客户端无法进行登录或退出登录。