CustomPermissionGroup
Represents a group of custom permissions for a Security Token
Hierarchy
↳ CustomPermissionGroup
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
id
• id: BigNumber
Defined in src/api/entities/CustomPermissionGroup.ts:44
ticker
• ticker: string
Inherited from PermissionGroup.ticker
Defined in src/api/entities/PermissionGroup.ts:27
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
getPermissions
▸ getPermissions(): Promise‹GroupPermissions›
Overrides PermissionGroup.getPermissions
Defined in src/api/entities/CustomPermissionGroup.ts:86
Retrieve the list of permissions and transaction groups 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:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean
setPermissions
▸ setPermissions(args: SetGroupPermissionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/CustomPermissionGroup.ts:79
Modify the group's permissions
note this method is of type ProcedureMethod, which means you can call setPermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹void››
toJson
▸ toJson(): HumanReadable
Defined in src/api/entities/CustomPermissionGroup.ts:65
Return the Group's ID
Returns: HumanReadable
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:
Name
Type
Description
identifiers
Identifiers
Returns: string
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:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated