Skip to main content
Version: 23.0.x

Class: KnownPermissionGroup

api/entities/KnownPermissionGroup.KnownPermissionGroup

Represents a pre-defined group of permissions for an Asset

Hierarchy

Properties

asset

asset: FungibleAsset

Asset for which this group specifies permissions

Inherited from

PermissionGroup.asset

Defined in

api/entities/PermissionGroup.ts:19


type

type: PermissionGroupType

Defined in

api/entities/KnownPermissionGroup.ts:30


uuid

uuid: string

Inherited from

PermissionGroup.uuid

Defined in

api/entities/Entity.ts:46

Methods

exists

exists(): Promise<boolean>

Determine whether this Known Permission Group exists on chain

Returns

Promise<boolean>

Overrides

PermissionGroup.exists


getPermissions

getPermissions(): Promise<GroupPermissions>

Retrieve the Permissions associated with this Permission Group

Returns

Promise<GroupPermissions>

Overrides

PermissionGroup.getPermissions


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

PermissionGroup.isEqual


toHuman

toHuman(): HumanReadable

Return the KnownPermissionGroup's static data

Returns

HumanReadable

Overrides

PermissionGroup.toHuman


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

PermissionGroup.generateUuid


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

PermissionGroup.unserialize