Skip to main content
Version: 23.0.x

Class: CustomPermissionGroup

api/entities/CustomPermissionGroup.CustomPermissionGroup

Represents a group of custom permissions for an Asset

Hierarchy

Properties

asset

asset: FungibleAsset

Asset for which this group specifies permissions

Inherited from

PermissionGroup.asset

Defined in

api/entities/PermissionGroup.ts:19


id

id: BigNumber

Defined in

api/entities/CustomPermissionGroup.ts:39


uuid

uuid: string

Inherited from

PermissionGroup.uuid

Defined in

api/entities/Entity.ts:46

Methods

exists

exists(): Promise<boolean>

Determine whether this Custom Permission Group exists on chain

Returns

Promise<boolean>

Overrides

PermissionGroup.exists


getPermissions

getPermissions(): Promise<GroupPermissions>

Retrieve the list of permissions and transaction groups associated with this Permission Group

Returns

Promise<GroupPermissions>

Overrides

PermissionGroup.getPermissions


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

PermissionGroup.isEqual


setPermissions

setPermissions(args, opts?): Promise<GenericPolymeshTransaction<void, 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 signing Account and Identity have the required roles and permissions to run it

Parameters

NameType
argsSetGroupPermissionsParams
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>


toHuman

toHuman(): HumanReadable

Return the Group's static data

Returns

HumanReadable

Overrides

PermissionGroup.toHuman


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

PermissionGroup.generateUuid


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

PermissionGroup.unserialize