CustomPermissionGroup

Represents a group of custom permissions for an Asset

Hierarchy

PermissionGroup

CustomPermissionGroup

Index

Properties

Methods

Properties

asset

asset: Asset

Inherited from PermissionGroup.asset

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

Asset for which this group specifies permissions


Protected context

context: Context

Inherited from CheckpointSchedule.context

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


id

id: BigNumber

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


uuid

uuid: string

Inherited from CheckpointSchedule.uuid

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

Methods

exists

exists(): Promise‹boolean›

Overrides Entity.exists

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

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:76

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 CheckpointSchedule.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:69

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 signing Account and Identity have the required roles and permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››


toJson

toJson(): HumanReadable

Overrides Entity.toJson

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

Return the Group's static data

Returns: HumanReadable


Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.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 CheckpointSchedule.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