Table of Contents

Class KookClientHostExtensions

Namespace
Kook.Net.Hosting
Assembly
Kook.Net.Hosting.dll

提供用于与 Microsoft.Extensions.Hosting 集成,注册与配置 Kook.Net 客户端作为服务的扩展方法。

public static class KookClientHostExtensions
Inheritance
KookClientHostExtensions
Inherited Members

Methods

AddHostedKookRestClient(IServiceCollection, KookRestConfig, TokenType, string, bool)

向指定的 IServiceCollection 添加 KookRestClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookRestClient(this IServiceCollection services, KookRestConfig config, TokenType tokenType, string token, bool validateToken = true)

Parameters

services IServiceCollection

要向其添加 KOOK REST 客户端及服务的服务集合。

config KookRestConfig

用于配置 KOOK REST 客户端的配置。

tokenType TokenType

令牌的类型。

token string

令牌。

validateToken bool

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK REST 客户端及服务的服务集合。

AddHostedKookRestClient(IServiceCollection, KookRestConfig, Func<IServiceProvider, TokenType>, Func<IServiceProvider, string>, Func<IServiceProvider, bool>?)

向指定的 IServiceCollection 添加 KookRestClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookRestClient(this IServiceCollection services, KookRestConfig config, Func<IServiceProvider, TokenType> tokenType, Func<IServiceProvider, string> token, Func<IServiceProvider, bool>? validateToken = null)

Parameters

services IServiceCollection

要向其添加 KOOK REST 客户端及服务的服务集合。

config KookRestConfig

用于配置 KOOK REST 客户端的配置。

tokenType Func<IServiceProvider, TokenType>

令牌的类型。

token Func<IServiceProvider, string>

令牌。

validateToken Func<IServiceProvider, bool>

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK REST 客户端及服务的服务集合。

AddHostedKookRestClient(IServiceCollection, Action<KookRestConfig>, TokenType, string, bool)

向指定的 IServiceCollection 添加 KookRestClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookRestClient(this IServiceCollection services, Action<KookRestConfig> configure, TokenType tokenType, string token, bool validateToken = true)

Parameters

services IServiceCollection

要向其添加 KOOK REST 客户端及服务的服务集合。

configure Action<KookRestConfig>

用于配置 KOOK REST 客户端的配置委托。

tokenType TokenType

令牌的类型。

token string

令牌。

validateToken bool

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK REST 客户端及服务的服务集合。

AddHostedKookRestClient(IServiceCollection, Action<KookRestConfig>, Func<IServiceProvider, TokenType>, Func<IServiceProvider, string>, Func<IServiceProvider, bool>?)

向指定的 IServiceCollection 添加 KookRestClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookRestClient(this IServiceCollection services, Action<KookRestConfig> configure, Func<IServiceProvider, TokenType> tokenType, Func<IServiceProvider, string> token, Func<IServiceProvider, bool>? validateToken = null)

Parameters

services IServiceCollection

要向其添加 KOOK REST 客户端及服务的服务集合。

configure Action<KookRestConfig>

用于配置 KOOK REST 客户端的配置委托。

tokenType Func<IServiceProvider, TokenType>

令牌的类型。

token Func<IServiceProvider, string>

令牌。

validateToken Func<IServiceProvider, bool>

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK REST 客户端及服务的服务集合。

AddHostedKookSocketClient(IServiceCollection, KookSocketConfig, TokenType, string, bool)

向指定的 IServiceCollection 添加 KookSocketClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookSocketClient(this IServiceCollection services, KookSocketConfig config, TokenType tokenType, string token, bool validateToken = true)

Parameters

services IServiceCollection

要向其添加 KOOK 网关客户端及服务的服务集合。

config KookSocketConfig

用于配置 KOOK 网关客户端的配置。

tokenType TokenType

令牌的类型。

token string

令牌。

validateToken bool

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK 网关客户端及服务的服务集合。

AddHostedKookSocketClient(IServiceCollection, KookSocketConfig, Func<IServiceProvider, TokenType>, Func<IServiceProvider, string>, Func<IServiceProvider, bool>?)

向指定的 IServiceCollection 添加 KookSocketClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookSocketClient(this IServiceCollection services, KookSocketConfig config, Func<IServiceProvider, TokenType> tokenType, Func<IServiceProvider, string> token, Func<IServiceProvider, bool>? validateToken = null)

Parameters

services IServiceCollection

要向其添加 KOOK 网关客户端及服务的服务集合。

config KookSocketConfig

用于配置 KOOK 网关客户端的配置。

tokenType Func<IServiceProvider, TokenType>

令牌的类型。

token Func<IServiceProvider, string>

令牌。

validateToken Func<IServiceProvider, bool>

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK 网关客户端及服务的服务集合。

AddHostedKookSocketClient(IServiceCollection, Action<KookSocketConfig>, TokenType, string, bool)

向指定的 IServiceCollection 添加 KookSocketClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookSocketClient(this IServiceCollection services, Action<KookSocketConfig> configure, TokenType tokenType, string token, bool validateToken = true)

Parameters

services IServiceCollection

要向其添加 KOOK 网关客户端及服务的服务集合。

configure Action<KookSocketConfig>

用于配置 KOOK 网关客户端的配置委托。

tokenType TokenType

令牌的类型。

token string

令牌。

validateToken bool

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK 网关客户端及服务的服务集合。

AddHostedKookSocketClient(IServiceCollection, Action<KookSocketConfig>, Func<IServiceProvider, TokenType>, Func<IServiceProvider, string>, Func<IServiceProvider, bool>?)

向指定的 IServiceCollection 添加 KookSocketClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookSocketClient(this IServiceCollection services, Action<KookSocketConfig> configure, Func<IServiceProvider, TokenType> tokenType, Func<IServiceProvider, string> token, Func<IServiceProvider, bool>? validateToken = null)

Parameters

services IServiceCollection

要向其添加 KOOK 网关客户端及服务的服务集合。

configure Action<KookSocketConfig>

用于配置 KOOK 网关客户端的配置委托。

tokenType Func<IServiceProvider, TokenType>

令牌的类型。

token Func<IServiceProvider, string>

令牌。

validateToken Func<IServiceProvider, bool>

是否在登录前验证令牌。

Returns

IServiceCollection

添加了 KOOK 网关客户端及服务的服务集合。

AddHostedKookWebhookClient<TClient, TConfig>(IServiceCollection, Func<IServiceProvider, IOptions<TConfig>, TClient>, Action<TConfig>, TokenType, string, bool)

向指定的 IServiceCollection 添加 KookWebhookClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookWebhookClient<TClient, TConfig>(this IServiceCollection services, Func<IServiceProvider, IOptions<TConfig>, TClient> clientFactory, Action<TConfig> configure, TokenType tokenType, string token, bool validateToken = true) where TClient : KookWebhookClient where TConfig : KookWebhookConfig

Parameters

services IServiceCollection

要向其添加基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

clientFactory Func<IServiceProvider, IOptions<TConfig>, TClient>

客户端创建委托。

configure Action<TConfig>

用于配置基于 Webhook 的 KOOK 网关客户端的配置委托。

tokenType TokenType

令牌的类型。

token string

令牌。

validateToken bool

是否在登录前验证令牌。

Returns

IServiceCollection

添加了基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

Type Parameters

TClient

客户端的类型。

TConfig

配置的类型。

AddHostedKookWebhookClient<TClient, TConfig>(IServiceCollection, Func<IServiceProvider, IOptions<TConfig>, TClient>, Action<TConfig>, Func<IServiceProvider, TokenType>, Func<IServiceProvider, string>, Func<IServiceProvider, bool>?)

向指定的 IServiceCollection 添加 KookWebhookClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookWebhookClient<TClient, TConfig>(this IServiceCollection services, Func<IServiceProvider, IOptions<TConfig>, TClient> clientFactory, Action<TConfig> configure, Func<IServiceProvider, TokenType> tokenType, Func<IServiceProvider, string> token, Func<IServiceProvider, bool>? validateToken = null) where TClient : KookWebhookClient where TConfig : KookWebhookConfig

Parameters

services IServiceCollection

要向其添加基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

clientFactory Func<IServiceProvider, IOptions<TConfig>, TClient>

客户端创建委托。

configure Action<TConfig>

用于配置基于 Webhook 的 KOOK 网关客户端的配置委托。

tokenType Func<IServiceProvider, TokenType>

令牌的类型。

token Func<IServiceProvider, string>

令牌。

validateToken Func<IServiceProvider, bool>

是否在登录前验证令牌。

Returns

IServiceCollection

添加了基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

Type Parameters

TClient

客户端的类型。

TConfig

配置的类型。

AddHostedKookWebhookClient<TClient, TConfig>(IServiceCollection, Func<IServiceProvider, TConfig, TClient>, TConfig, TokenType, string, bool)

向指定的 IServiceCollection 添加 KookWebhookClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookWebhookClient<TClient, TConfig>(this IServiceCollection services, Func<IServiceProvider, TConfig, TClient> clientFactory, TConfig config, TokenType tokenType, string token, bool validateToken = true) where TClient : KookWebhookClient where TConfig : KookWebhookConfig

Parameters

services IServiceCollection

要向其添加基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

clientFactory Func<IServiceProvider, TConfig, TClient>

客户端创建委托。

config TConfig

用于配置基于 Webhook 的 KOOK 网关客户端的配置。

tokenType TokenType

令牌的类型。

token string

令牌。

validateToken bool

是否在登录前验证令牌。

Returns

IServiceCollection

添加了基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

Type Parameters

TClient

客户端的类型。

TConfig

配置的类型。

AddHostedKookWebhookClient<TClient, TConfig>(IServiceCollection, Func<IServiceProvider, TConfig, TClient>, TConfig, Func<IServiceProvider, TokenType>, Func<IServiceProvider, string>, Func<IServiceProvider, bool>?)

向指定的 IServiceCollection 添加 KookWebhookClient 客户端,并添加包装为 IHostedService 的服务。

public static IServiceCollection AddHostedKookWebhookClient<TClient, TConfig>(this IServiceCollection services, Func<IServiceProvider, TConfig, TClient> clientFactory, TConfig config, Func<IServiceProvider, TokenType> tokenType, Func<IServiceProvider, string> token, Func<IServiceProvider, bool>? validateToken = null) where TClient : KookWebhookClient where TConfig : KookWebhookConfig

Parameters

services IServiceCollection

要向其添加基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

clientFactory Func<IServiceProvider, TConfig, TClient>

客户端创建委托。

config TConfig

用于配置基于 Webhook 的 KOOK 网关客户端的配置。

tokenType Func<IServiceProvider, TokenType>

令牌的类型。

token Func<IServiceProvider, string>

令牌。

validateToken Func<IServiceProvider, bool>

是否在登录前验证令牌。

Returns

IServiceCollection

添加了基于 Webhook 的 KOOK 网关客户端及服务的服务集合。

Type Parameters

TClient

客户端的类型。

TConfig

配置的类型。