Class: CustomPermissionGroup

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

Represents a group of custom permissions for an Asset

Extends

• PermissionGroup

Properties

asset

asset: BaseAsset

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

Asset for which this group specifies permissions

Inherited from

PermissionGroup.asset

---

id

id: BigNumber

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

---

uuid

uuid: string

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

Inherited from

PermissionGroup.uuid

Methods

exists()

exists(): Promise<boolean>

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

Determine whether this Custom Permission Group exists on chain

Returns

Promise<boolean>

Overrides

PermissionGroup.exists

---

getPermissions()

getPermissions(): Promise<GroupPermissions>

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

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

Returns

Promise<GroupPermissions>

Overrides

PermissionGroup.getPermissions

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

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

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

PermissionGroup.isEqual

---

setPermissions()

setPermissions(args: SetGroupPermissionsParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

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

Modify the group's permissions

Parameters

Parameter	Type
args	SetGroupPermissionsParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

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

---

toHuman()

toHuman(): HumanReadable

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

Return the Group's static data

Returns

HumanReadable

Overrides

PermissionGroup.toHuman

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers

Returns

string

Inherited from

PermissionGroup.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

PermissionGroup.unserialize