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
↳
CustomPermissionGroup
Table of contents
Properties
Methods
Properties
asset
• asset: Asset
Asset for which this group specifies permissions
Inherited from
Defined in
api/entities/PermissionGroup.ts:19
id
• id: BigNumber
Defined in
api/entities/CustomPermissionGroup.ts:45
uuid
• uuid: string
Inherited from
Defined in
Methods
exists
▸ exists(): Promise<boolean>
Determine whether this Custom Permission Group exists on chain
Returns
Promise<boolean>
Overrides
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
entity
Returns
boolean
Inherited from
Defined in
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
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
api/entities/CustomPermissionGroup.ts:69
toHuman
▸ toHuman(): HumanReadable
Return the Group's static data
Returns
Overrides
Defined in
api/entities/CustomPermissionGroup.ts:124
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
Last updated