CustomPermissionGroup

Represents a group of custom permissions for a Security Token

Hierarchy

PermissionGroup

CustomPermissionGroup

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from Entity.context

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

id

id: BigNumber

Defined in src/api/entities/CustomPermissionGroup.ts:45

ticker

ticker: string

Inherited from PermissionGroup.ticker

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

uuid

uuid: string

Inherited from Entity.uuid

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

Methods

exists

exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/CustomPermissionGroup.ts:117

Determine whether this Custom Permission Group exists on chain

Returns: Promise‹boolean›

getPermissions

getPermissions(): Promise‹GroupPermissions

Overrides PermissionGroup.getPermissions

Defined in src/api/entities/CustomPermissionGroup.ts:87

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

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

Determine whether this Entity is the same as another one

Parameters:

NameType

entity

Entity‹unknown, unknown›

Returns: boolean

setPermissions

setPermissions(args: SetGroupPermissionsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/CustomPermissionGroup.ts:80

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

Overrides Entity.toJson

Defined in src/api/entities/CustomPermissionGroup.ts:66

Return the Group's ID

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:

NameTypeDescription

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:

NameTypeDescription

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated