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

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

Represents a group of permissions for an Asset

• Entity<UniqueIdentifiers, unknown>

• CustomPermissionGroup
• KnownPermissionGroup

asset: BaseAsset

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

Asset for which this group specifies permissions

uuid: string

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

Entity.uuid

abstract exists(): Promise<boolean>

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

Determine whether this Entity exists on chain

Promise<boolean>

Entity.exists

abstract getPermissions(): Promise<GroupPermissions>

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

Retrieve the Permissions associated with this Permission Group

Promise<GroupPermissions>

isEqual(entity): boolean

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

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

abstract toHuman(): unknown

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

Returns Entity data in a human readable (JSON) format

unknown

Entity.toHuman

static generateUuid<Identifiers>(identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

Entity.generateUuid

static isUniqueIdentifiers(identifiers): boolean

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

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

Parameter	Type	Description
identifiers	unknown	object to type check

boolean

Entity.isUniqueIdentifiers

static unserialize<Identifiers>(serialized): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

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

assetId: string

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

optional id?: BigNumber

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

optional type?: PermissionGroupType

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