PermissionGroup
Represents a group of permissions for a Security Token
Hierarchy
Index
Properties
Methods
Properties
Protected
context
Protected
context• context: Context
Defined in src/api/entities/Entity.ts:48
ticker
• ticker: string
Defined in src/api/entities/PermissionGroup.ts:27
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
Abstract
getPermissions
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
Defined in src/api/entities/Entity.ts:61
Whether this Entity is the same as another one
Parameters:
Returns: boolean
Abstract
toJson
Abstract
toJson▸ toJson(): unknown
Defined in src/api/entities/Entity.ts:68
Returns Entity data in a human readable (JSON) format
Returns: unknown
Static
generateUuid
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:
Returns: string
Static
isUniqueIdentifiers
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:
Returns: boolean
Static
unserialize
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:
Returns: Identifiers
Last updated