CustomPermissionGroup
Represents a group of custom permissions for a Security Token

Hierarchy

CustomPermissionGroup

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from Entity.context

id

id: BigNumber

ticker

ticker: string
Inherited from PermissionGroup.ticker

uuid

uuid: string
Inherited from Entity.uuid

Methods

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Custom Permission Group exists on chain
Returns: Promise‹boolean›

getPermissions

getPermissions(): Promise‹GroupPermissions
Retrieve the list of permissions and transaction groups associated with this Permission Group
Returns: Promise‹GroupPermissions

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine 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››
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:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable
Overrides Entity.toJson
Return the Group's ID
Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago