meshcore.js
ReferenceClasses

PermissionManager

Defined in: packages/client/src/permissions/permission-manager.ts:83

client.permissions: the registered permissions and the checks the command dispatcher runs before a handler: has(), missing(), holders().

Constructors

Constructor

new PermissionManager(client): PermissionManager;

Defined in: packages/client/src/permissions/permission-manager.ts:88

Parameters

client

Client

Owning client

Returns

PermissionManager

Properties

client

readonly client: Client;

Defined in: packages/client/src/permissions/permission-manager.ts:84

Methods

canManageContact()

canManageContact(author, target): Promise<boolean>;

Defined in: packages/client/src/permissions/permission-manager.ts:194

Parameters

author

Author

Message author

target

Contact

Contact to act on

Returns

Promise<boolean>


canManageRole()

canManageRole(author, role): Promise<boolean>;

Defined in: packages/client/src/permissions/permission-manager.ts:186

Parameters

author

Author

Message author

role

Role

Role to give or take

Returns

Promise<boolean>


get()

get(permission): Permission | undefined;

Defined in: packages/client/src/permissions/permission-manager.ts:94

Parameters

permission

PermissionLike

Permission builder or name

Returns

Permission | undefined


has()

has(author, permission): Promise<boolean>;

Defined in: packages/client/src/permissions/permission-manager.ts:161

Parameters

author

Author

Message author

permission

PermissionLike

Permission builder or name

Returns

Promise<boolean>


hasRole()

hasRole(author, role): Promise<boolean>;

Defined in: packages/client/src/permissions/permission-manager.ts:140

Parameters

author

Author

Message author

role

string | Role

Role or role name

Returns

Promise<boolean>


list()

list(): Permission[];

Defined in: packages/client/src/permissions/permission-manager.ts:99

Returns

Permission[]


rank()

rank(author): Promise<number>;

Defined in: packages/client/src/permissions/permission-manager.ts:177

Parameters

author

Author

Message author

Returns

Promise<number>


resolve()

resolve(author): Promise<Set<Permission>>;

Defined in: packages/client/src/permissions/permission-manager.ts:146

Parameters

author

Author

Message author

Returns

Promise<Set<Permission>>


rolesOf()

rolesOf(author): Promise<Role[]>;

Defined in: packages/client/src/permissions/permission-manager.ts:129

Parameters

author

Author

Message author

Returns

Promise<Role[]>


whoHas()

whoHas(permission): Promise<PermissionHolder[]>;

Defined in: packages/client/src/permissions/permission-manager.ts:200

Parameters

permission

PermissionLike

Permission builder or name

Returns

Promise<PermissionHolder[]>

On this page