Class PermissionManagerService

Hierarchy (View Summary, Expand)

AbstractPermissionManagerService
- PermissionManagerService

Constructors

constructor

new PermissionManagerService(application: Application): PermissionManagerService
Parameters
- application: Application
Returns PermissionManagerService
Overrides AbstractPermissionManagerService.constructor
- Defined in src/main/typescript/services/PermissionManagerService.ts:45

Properties

`Protected` `Readonly`application

application: Application

`Protected` `Readonly`client

client: BaseClient

`Protected` `Readonly`logger

logger: Logger

`Readonly`managers

managers: Partial<
Record<"discord" | "levels" | "layered", AbstractPermissionManager>,
> = {}

`Protected` `Readonly`permissionInstances

permissionInstances: Collection<"system.admin", Permission> = ...

`Protected` `Static`name

name: string

Returns the name of the function. Function names are read-only and can not be changed.

Methods

boot

boot(): Awaitable<void>
Returns Awaitable<void>
Inherited from AbstractPermissionManagerService.boot
- Defined in src/framework/typescript/services/Service.ts:30

canAutoModerate

canAutoModerate(member: GuildMember): Promise<boolean>
Parameters
- member: GuildMember
Returns Promise<boolean>
- Defined in src/main/typescript/services/PermissionManagerService.ts:124

canBypassGuildRestrictions

canBypassGuildRestrictions(member: GuildMember): boolean
Parameters
- member: GuildMember
Returns boolean
Inherited from AbstractPermissionManagerService.canBypassGuildRestrictions
- Defined in src/framework/typescript/permissions/AbstractPermissionManagerService.ts:106

canModerate

canModerate(
    member: GuildMember,
    moderator: GuildMember,
    forceNoSameMemberCheck?: boolean,
): Promise<boolean>
Parameters
- member: GuildMember
- moderator: GuildMember
- OptionalforceNoSameMemberCheck: boolean
Returns Promise<boolean>
- Defined in src/main/typescript/services/PermissionManagerService.ts:148

getAllPermissions

getAllPermissions(): Collection<"system.admin", Permission>
Returns Collection<"system.admin", Permission>
Inherited from AbstractPermissionManagerService.getAllPermissions
- Defined in src/framework/typescript/permissions/AbstractPermissionManagerService.ts:90

`Protected`getManager

getManager(guildId: string): Promise<AbstractPermissionManager>
Parameters
- guildId: string
Returns Promise<AbstractPermissionManager>
- Defined in src/main/typescript/services/PermissionManagerService.ts:111

getManagerForGuild

getManagerForGuild(
guildResolvable: string | Guild,
): Promise<AbstractPermissionManager>
Parameters
- guildResolvable: string | Guild
Returns Promise<AbstractPermissionManager>
- Defined in src/main/typescript/services/PermissionManagerService.ts:85

getMemberPermissions

getMemberPermissions<T extends AbstractPermissionManager>(
member: GuildMember,
): Promise<GenericAwaited<ReturnType<T["getMemberPermissions"]>>>
Type Parameters
- T extends AbstractPermissionManager
Parameters
- member: GuildMember
Returns Promise<GenericAwaited<ReturnType<T["getMemberPermissions"]>>>
Overrides AbstractPermissionManagerService.getMemberPermissions
- Defined in src/main/typescript/services/PermissionManagerService.ts:103

getPermissionByName

getPermissionByName(name: string): undefined | Permission
Parameters
- name: string
Returns undefined | Permission
Inherited from AbstractPermissionManagerService.getPermissionByName
- Defined in src/framework/typescript/permissions/AbstractPermissionManagerService.ts:86

getSystemAdminPermission

getSystemAdminPermission(): Promise<Permission>
Returns Promise<Permission>
Inherited from AbstractPermissionManagerService.getSystemAdminPermission
- Defined in src/framework/typescript/permissions/AbstractPermissionManagerService.ts:67

hasPermissions

hasPermissions(
    member: GuildMember,
    permissions: SystemPermissionResolvable[],
    alreadyComputedPermissions?: MemberPermissionData,
): Promise<boolean>
Parameters
- member: GuildMember
- permissions: SystemPermissionResolvable[]
- OptionalalreadyComputedPermissions: MemberPermissionData
Returns Promise<boolean>
Overrides AbstractPermissionManagerService.hasPermissions
- Defined in src/main/typescript/services/PermissionManagerService.ts:91

isModerator

isModerator(member: GuildMember): Promise<boolean>
Parameters
- member: GuildMember
Returns Promise<boolean>
Inherited from AbstractPermissionManagerService.isModerator
- Defined in src/framework/typescript/permissions/AbstractPermissionManagerService.ts:113

isSystemAdmin

isSystemAdmin(member: GuildMember): Promise<boolean>
Parameters
- member: GuildMember
Returns Promise<boolean>
Inherited from AbstractPermissionManagerService.isSystemAdmin
- Defined in src/framework/typescript/permissions/AbstractPermissionManagerService.ts:101

loadPermission

loadPermission(permission: Permission): void
Parameters
- permission: Permission
Returns void
Inherited from AbstractPermissionManagerService.loadPermission
- Defined in src/framework/typescript/permissions/AbstractPermissionManagerService.ts:79

`Static`getName

getName(): string
Returns string
Inherited from AbstractPermissionManagerService.getName
- Defined in src/framework/typescript/services/Service.ts:38

Class PermissionManagerService

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PermissionManagerService

Properties

Protected Readonlyapplication

Protected Readonlyclient

Protected Readonlylogger

Readonlymanagers

Protected ReadonlypermissionInstances

Protected Staticname

Methods

boot

Returns Awaitable<void>

canAutoModerate

Parameters

Returns Promise<boolean>

canBypassGuildRestrictions

Parameters

Returns boolean

canModerate

Parameters

Returns Promise<boolean>

getAllPermissions

Returns Collection<"system.admin", Permission>

ProtectedgetManager

Parameters

Returns Promise<AbstractPermissionManager>

getManagerForGuild

Parameters

Returns Promise<AbstractPermissionManager>

getMemberPermissions

Type Parameters

Parameters

Returns Promise<GenericAwaited<ReturnType<T["getMemberPermissions"]>>>

getPermissionByName

Parameters

Returns undefined | Permission

getSystemAdminPermission

Returns Promise<Permission>

hasPermissions

Parameters

Returns Promise<boolean>

isModerator

Parameters

Returns Promise<boolean>

isSystemAdmin

Parameters

Returns Promise<boolean>

loadPermission

Parameters

Returns void

StaticgetName

Returns string

Settings

On This Page

`Protected` `Readonly`application

`Protected` `Readonly`client

`Protected` `Readonly`logger

`Readonly`managers

`Protected` `Readonly`permissionInstances

`Protected` `Static`name

`Protected`getManager

`Static`getName