Table of Contents

Class RequireRoleAttribute

Namespace
Kook.Commands
Assembly
Kook.Net.Commands.dll

要求调用命令的用户在命令调用所在的服务器拥有指定的角色。

[AttributeUsage(AttributeTargets.Class|AttributeTargets.Method, AllowMultiple = true)]
public class RequireRoleAttribute : PreconditionAttribute
Inheritance
RequireRoleAttribute
Inherited Members

Constructors

RequireRoleAttribute(string)

初始化一个 RequireRoleAttribute 类的新实例。

public RequireRoleAttribute(string roleName)

Parameters

roleName string

所要求调用命令的用户需要在命令调用所在的的服务器拥有的角色的名称。

RequireRoleAttribute(uint)

初始化一个 RequireRoleAttribute 类的新实例。

public RequireRoleAttribute(uint roleId)

Parameters

roleId uint

所要求调用命令的用户需要在命令调用所在的的服务器拥有的角色的 ID。

Properties

NotAGuildErrorMessage

获取或设置由于在服务器频道外执行命令而导致的先决条件失败的错误消息。

public string? NotAGuildErrorMessage { get; set; }

Property Value

string

Methods

CheckPermissionsAsync(ICommandContext, CommandInfo, IServiceProvider)

检查命令执行上下文中的此命令是否满足此先决条件。

public override Task<PreconditionResult> CheckPermissionsAsync(ICommandContext context, CommandInfo command, IServiceProvider services)

Parameters

context ICommandContext

命令执行上下文。

command CommandInfo

要执行的命令。

services IServiceProvider

依赖注入服务容器。

Returns

Task<PreconditionResult>

一个表示异步检查操作的任务。任务的结果包含先决条件的结果。