Skip to main content
Version: v29.0.x

Class: KnownPermissionGroup

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

Represents a pre-defined group of permissions for an Asset

Extends

Properties

asset

asset: BaseAsset

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

Asset for which this group specifies permissions

Inherited from

PermissionGroup.asset


type

type: PermissionGroupType

Defined in: src/api/entities/KnownPermissionGroup.ts:30


uuid

uuid: string

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

Inherited from

PermissionGroup.uuid

Methods

exists()

exists(): Promise<boolean>

Defined in: src/api/entities/KnownPermissionGroup.ts:90

Determine whether this Known Permission Group exists on chain

Returns

Promise<boolean>

Overrides

PermissionGroup.exists


getPermissions()

getPermissions(): Promise<GroupPermissions>

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

Retrieve the Permissions associated with this Permission Group

Returns

Promise<GroupPermissions>

Overrides

PermissionGroup.getPermissions


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

ParameterType

entity

Entity<unknown, unknown>

Returns

boolean

Inherited from

PermissionGroup.isEqual


toHuman()

toHuman(): HumanReadable

Defined in: src/api/entities/KnownPermissionGroup.ts:97

Return the KnownPermissionGroup's static data

Returns

HumanReadable

Overrides

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

ParameterTypeDescription

identifiers

Identifiers

Returns

string

Inherited from

PermissionGroup.generateUuid


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

ParameterTypeDescription

serialized

string

UUID to unserialize

Returns

Identifiers

Inherited from

PermissionGroup.unserialize