meshcore.js
ReferenceClasses

PermissionBuilder

Defined in: packages/client/src/permissions/permission-builder.ts:14

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

Implements

Constructors

Constructor

new PermissionBuilder(options?): PermissionBuilder;

Defined in: packages/client/src/permissions/permission-builder.ts:21

Parameters

options?

core allows the reserved core. prefix

core?

boolean

Returns

PermissionBuilder

Properties

[BRICK]

readonly [BRICK]: "permission";

Defined in: packages/client/src/permissions/permission-builder.ts:15

Implementation of

Brick.[BRICK]

Accessors

name

Get Signature

get name(): string;

Defined in: packages/client/src/permissions/permission-builder.ts:25

Returns

string

Methods

build()

build(): PermissionDefinition;

Defined in: packages/client/src/permissions/permission-builder.ts:41

Returns

PermissionDefinition

Implementation of

Brick.build


setDescription()

setDescription(description): this;

Defined in: packages/client/src/permissions/permission-builder.ts:36

Parameters

description

string

Free text for the bot author

Returns

this


setName()

setName(name): this;

Defined in: packages/client/src/permissions/permission-builder.ts:30

Parameters

name

string

Lowercase, letters digits _ . and -, 1 to 64 characters

Returns

this

On this page