Role

Defined in: packages/client/src/permissions/role.ts:11

A registered role: its permissions, its members (resolved from the list or the source, cached), and invalidate() to force a re-read.

Constructors

Constructor

new Role(client, definition): Role;

Defined in: packages/client/src/permissions/role.ts:26

Parameters

client

Client

Owning client

definition

RoleDefinition

Built by RoleBuilder

Returns

Role

Properties

client

readonly client: Client;

Defined in: packages/client/src/permissions/role.ts:12

description

readonly description: string;

Defined in: packages/client/src/permissions/role.ts:14

name

readonly name: string;

Defined in: packages/client/src/permissions/role.ts:13

permissionNames

readonly permissionNames: readonly string[];

Defined in: packages/client/src/permissions/role.ts:16

priority

readonly priority: number;

Defined in: packages/client/src/permissions/role.ts:15

Methods

fetchMembers()

fetchMembers(): Promise<ResolvedMember[]>;

Defined in: packages/client/src/permissions/role.ts:59

Returns

Promise<ResolvedMember[]>

has()

has(contact): Promise<boolean>;

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

Parameters

contact

Contact

Contact to look up

Returns

Promise<boolean>

invalidate()

invalidate(): void;

Defined in: packages/client/src/permissions/role.ts:35

Returns

void

toString()

toString(): string;

Defined in: packages/client/src/permissions/role.ts:71

Returns

string