api_entities_CustomPermissionGroup.CustomPermissionGroup

@polymeshassociation/polymesh-sdk / Modules / api/entities/CustomPermissionGroup / CustomPermissionGroup

Class: CustomPermissionGroup

api/entities/CustomPermissionGroup.CustomPermissionGroup

Represents a group of custom permissions for an Asset

Hierarchy

• PermissionGroup

  ↳ CustomPermissionGroup

Table of contents

Properties

• asset

• id

• uuid

Methods

• exists

• getPermissions

• isEqual

• setPermissions

• toHuman

• generateUuid

• unserialize

Properties

asset

• asset: Asset

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

---

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

Defined in

api/entities/CustomPermissionGroup.ts:106

---

getPermissions

▸ getPermissions(): Promise<GroupPermissions>

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

Returns

Promise<GroupPermissions>

Overrides

PermissionGroup.getPermissions

Defined in

api/entities/CustomPermissionGroup.ts:76

---

isEqual

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Name	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

PermissionGroup.isEqual

Defined in

api/entities/Entity.ts:61

---

setPermissions

▸ setPermissions(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>

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

Name	Type
args	SetGroupPermissionsParams
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<void, void, unknown[][]>>

Defined in

api/entities/CustomPermissionGroup.ts:69

---

toHuman

▸ toHuman(): HumanReadable

Return the Group's static data

Returns

HumanReadable

Overrides

PermissionGroup.toHuman

Defined in

api/entities/CustomPermissionGroup.ts:124

---

generateUuid

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

Name	Type
identifiers	Identifiers

Returns

string

Inherited from

PermissionGroup.generateUuid

Defined in

api/entities/Entity.ts:14

---

unserialize

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

Name	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

PermissionGroup.unserialize

Defined in

api/entities/Entity.ts:23