RoleBuilder

Defined in: packages/client/src/permissions/role-builder.ts:47

What every builder (CommandBuilder, EventBuilder, …) produces: a build() method tagged with its kind.

Implements

• Brick<RoleDefinition>

Constructors

Constructor

new RoleBuilder(): RoleBuilder;

Returns

RoleBuilder

Properties

[BRICK]

readonly [BRICK]: "role";

Defined in: packages/client/src/permissions/role-builder.ts:48

Implementation of

Brick.[BRICK]

Accessors

name

Get Signature

get name(): string;

Defined in: packages/client/src/permissions/role-builder.ts:56

Returns

string

Methods

addPermissions()

addPermissions(...permissions): this;

Defined in: packages/client/src/permissions/role-builder.ts:79

Parameters

permissions

...PermissionLike[]

Permissions granted by the role

Returns

this

build()

build(): RoleDefinition;

Defined in: packages/client/src/permissions/role-builder.ts:94

Returns

RoleDefinition

Implementation of

Brick.build

setDescription()

setDescription(description): this;

Defined in: packages/client/src/permissions/role-builder.ts:67

Parameters

description

string

Free text for the bot author

Returns

this

setMembers()

setMembers(source, options?): this;

Defined in: packages/client/src/permissions/role-builder.ts:88

Parameters

source

MemberSource

Public keys, or a function returning them

options?

cacheTtl in seconds for a function source. Default 0

cacheTtl?

number

Returns

this

setName()

setName(name): this;

Defined in: packages/client/src/permissions/role-builder.ts:61

Parameters

name

string

Unique role name

Returns

this

setPriority()

setPriority(priority): this;

Defined in: packages/client/src/permissions/role-builder.ts:73

Parameters

priority

number

Unique integer, higher ranks above

Returns

this