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

Defined in: api/entities/CustomPermissionGroup.ts:33

Represents a group of custom permissions for an Asset

• PermissionGroup

asset: BaseAsset

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

Asset for which this group specifies permissions

PermissionGroup.asset

id: BigNumber

Defined in: api/entities/CustomPermissionGroup.ts:44

uuid: string

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

PermissionGroup.uuid

exists(): Promise<boolean>

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

Determine whether this Custom Permission Group exists on chain

Promise<boolean>

PermissionGroup.exists

getPermissions(): Promise<GroupPermissions>

Defined in: api/entities/CustomPermissionGroup.ts:70

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

Promise<GroupPermissions>

PermissionGroup.getPermissions

isEqual(entity): boolean

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

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

PermissionGroup.isEqual

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

Defined in: api/entities/CustomPermissionGroup.ts:65

Modify the group's permissions

Parameter	Type
args	SetGroupPermissionsParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

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(): HumanReadable

Defined in: api/entities/CustomPermissionGroup.ts:120

Return the Group's static data

HumanReadable

PermissionGroup.toHuman

static generateUuid<Identifiers>(identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

PermissionGroup.generateUuid

static unserialize<Identifiers>(serialized): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

PermissionGroup.unserialize

Defined in: api/entities/CustomPermissionGroup.ts:20

assetId: string

Defined in: api/entities/CustomPermissionGroup.ts:22

id: string

Defined in: api/entities/CustomPermissionGroup.ts:21

---

Defined in: api/entities/CustomPermissionGroup.ts:25

assetId: string

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

id: BigNumber

Defined in: api/entities/CustomPermissionGroup.ts:26