KnownPermissionGroup

Represents a pre-defined group of permissions for a Security Token

Hierarchy

PermissionGroup

KnownPermissionGroup

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from Entity.context

Defined in src/api/entities/Entity.ts:48

ticker

ticker: string

Inherited from PermissionGroup.ticker

Defined in src/api/entities/PermissionGroup.ts:27

type

type: PermissionGroupType

Defined in src/api/entities/KnownPermissionGroup.ts:30

uuid

uuid: string

Inherited from Entity.uuid

Defined in src/api/entities/Entity.ts:46

Methods

getPermissions

getPermissions(): Promise‹GroupPermissions

Overrides PermissionGroup.getPermissions

Defined in src/api/entities/KnownPermissionGroup.ts:46

Retrieve the Permissions associated with this Permission Group

Returns: Promise‹GroupPermissions

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from Entity.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹unknown, unknown›

Returns: boolean

toJson

toJson(): HumanReadable

Overrides Entity.toJson

Defined in src/api/entities/KnownPermissionGroup.ts:90

Return the KnownPermissionGroup's static data

Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from Entity.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from Entity.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated