PermissionGroup

Represents a group of permissions for a Security Token

Hierarchy

• Entity‹UniqueIdentifiers, unknown›

  ↳ PermissionGroup

  ↳ KnownPermissionGroup

  ↳ CustomPermissionGroup

Index

Properties

• context

• ticker

• uuid

Methods

• getPermissions

• isEqual

• toJson

• generateUuid

• isUniqueIdentifiers

• unserialize

Properties

Protected context

• context: Context

Inherited from Entity.context

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

ticker

• ticker: string

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

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

Abstract getPermissions

▸ getPermissions(): Promise‹GroupPermissions›

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

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

Abstract toJson

▸ toJson(): unknown

Inherited from Entity.toJson

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

Returns Entity data in a human readable (JSON) format

Returns: unknown

Static generateUuid

▸ generateUuid‹Identifiers›(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 isUniqueIdentifiers

▸ isUniqueIdentifiers(identifiers: unknown): boolean

Inherited from Entity.isUniqueIdentifiers

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

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

Parameters:

Name	Type	Description
identifiers	unknown	object to type check

Returns: boolean

Static unserialize

▸ unserialize‹Identifiers›(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