Abstract Class: PermissionGroup

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

Represents a group of permissions for an Asset

Extends

• Entity<UniqueIdentifiers, unknown>

Extended by

• CustomPermissionGroup
• KnownPermissionGroup

Properties

asset

asset: BaseAsset

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

Asset for which this group specifies permissions

---

uuid

uuid: string

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

Inherited from

Entity.uuid

Methods

exists()

abstract exists(): Promise<boolean>

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

Determine whether this Entity exists on chain

Returns

Promise<boolean>

Inherited from

Entity.exists

---

getPermissions()

abstract getPermissions(): Promise<GroupPermissions>

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

Retrieve the Permissions associated with this Permission Group

Returns

Promise<GroupPermissions>

---

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

Entity.isEqual

---

toHuman()

abstract toHuman(): unknown

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

Returns Entity data in a human readable (JSON) format

Returns

unknown

Inherited from

Entity.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

Entity.generateUuid

---

isUniqueIdentifiers()

static isUniqueIdentifiers(identifiers: unknown): boolean

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

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

Parameters

Parameter	Type	Description
identifiers	unknown	object to type check

Returns

boolean

Inherited from

Entity.isUniqueIdentifiers

---

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

Entity.unserialize