api_entities_PermissionGroup.PermissionGroup

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

Class: PermissionGroup

api/entities/PermissionGroup.PermissionGroup

Represents a group of permissions for an Asset

Hierarchy

• Entity<UniqueIdentifiers, unknown>

  ↳ PermissionGroup

  ↳↳ CustomPermissionGroup

  ↳↳ KnownPermissionGroup

Table of contents

Properties

• asset

• uuid

Methods

• exists

• getPermissions

• isEqual

• toHuman

• generateUuid

• isUniqueIdentifiers

• unserialize

Properties

asset

• asset: Asset

Asset for which this group specifies permissions

Defined in

api/entities/PermissionGroup.ts:19

---

uuid

• uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

exists

▸ Abstract exists(): Promise<boolean>

Determine whether this Entity exists on chain

Returns

Promise<boolean>

Inherited from

Entity.exists

Defined in

api/entities/Entity.ts:68

---

getPermissions

▸ Abstract getPermissions(): Promise<GroupPermissions>

Retrieve the Permissions associated with this Permission Group

Returns

Promise<GroupPermissions>

Defined in

api/entities/PermissionGroup.ts:35

---

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

Entity.isEqual

Defined in

api/entities/Entity.ts:61

---

toHuman

▸ Abstract toHuman(): unknown

Returns Entity data in a human readable (JSON) format

Returns

unknown

Inherited from

Entity.toHuman

Defined in

api/entities/Entity.ts:73

---

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

Entity.generateUuid

Defined in

api/entities/Entity.ts:14

---

isUniqueIdentifiers

▸ Static isUniqueIdentifiers(identifiers): boolean

Typeguard that checks whether the object passed corresponds to the unique identifiers of the class. Must be overridden

Parameters

Name	Type	Description
identifiers	unknown	object to type check

Returns

boolean

Inherited from

Entity.isUniqueIdentifiers

Defined in

api/entities/Entity.ts:42

---

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

Entity.unserialize

Defined in

api/entities/Entity.ts:23