api.entities.KnownPermissionGroup - PolymeshAssociation/polymesh-sdk GitHub Wiki

@polymeshassociation/polymesh-sdk / api/entities/KnownPermissionGroup

api/entities/KnownPermissionGroup

Classes

KnownPermissionGroup

Defined in: api/entities/KnownPermissionGroup.ts:27

Represents a pre-defined group of permissions for an Asset

Extends

Properties

asset

asset: BaseAsset

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

Asset for which this group specifies permissions

Inherited from

PermissionGroup.asset

type

type: PermissionGroupType

Defined in: api/entities/KnownPermissionGroup.ts:38

uuid

uuid: string

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

Inherited from

PermissionGroup.uuid

Methods

exists()

exists(): Promise<boolean>

Defined in: api/entities/KnownPermissionGroup.ts:103

Determine whether this Known Permission Group exists on chain

Returns

Promise<boolean>

Overrides

PermissionGroup.exists

getPermissions()

getPermissions(): Promise<GroupPermissions>

Defined in: api/entities/KnownPermissionGroup.ts:54

Retrieve the Permissions associated with this Permission Group

Returns

Promise<GroupPermissions>

Overrides

PermissionGroup.getPermissions

isEqual()

isEqual(entity): boolean

Defined in: 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

PermissionGroup.isEqual

toHuman()

toHuman(): HumanReadable

Defined in: api/entities/KnownPermissionGroup.ts:110

Return the KnownPermissionGroup's static data

Returns

HumanReadable

Overrides

PermissionGroup.toHuman

generateUuid()

static generateUuid<Identifiers>(identifiers): string

Defined in: 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

PermissionGroup.generateUuid

unserialize()

static unserialize<Identifiers>(serialized): Identifiers

Defined in: 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

PermissionGroup.unserialize

Interfaces

HumanReadable

Defined in: api/entities/KnownPermissionGroup.ts:14

Properties

assetId

assetId: string

Defined in: api/entities/KnownPermissionGroup.ts:16

type

type: PermissionGroupType

Defined in: api/entities/KnownPermissionGroup.ts:15


UniqueIdentifiers

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

Properties

assetId

assetId: string

Defined in: api/entities/KnownPermissionGroup.ts:21

type

type: PermissionGroupType

Defined in: api/entities/KnownPermissionGroup.ts:20

⚠️ **GitHub.com Fallback** ⚠️