Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • asset
  • Protected context
  • uuid
  • Methods
  • Abstract exists
  • Abstract getPermissions
  • isEqual
  • Abstract toHuman
  • Static generateUuid
  • Static isUniqueIdentifiers
  • Static unserialize

Was this helpful?

  1. Classes

PermissionGroup

PreviousPercentageNextPermissions

Last updated 2 years ago

Was this helpful?

Represents a group of permissions for an Asset

Hierarchy

  • ‹UniqueIdentifiers, unknown›

    ↳ PermissionGroup

    ↳

    ↳

Index

Properties

Methods

Properties

asset

Asset for which this group specifies permissions


Protected context

• context: Context


uuid

• uuid: string

Methods

Abstract exists

▸ exists(): Promise‹boolean›

Determine whether this Entity exists on chain

Returns: Promise‹boolean›


Abstract getPermissions

Retrieve the Permissions associated with this Permission Group


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


Abstract toHuman

â–¸ toHuman(): unknown

Returns Entity data in a human readable (JSON) format

Returns: unknown


Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string


Static isUniqueIdentifiers

â–¸ isUniqueIdentifiers(identifiers: unknown): boolean

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

Parameters:

Name
Type
Description

identifiers

unknown

object to type check

Returns: boolean


Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

• asset:

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

▸ getPermissions(): Promise‹›

Defined in

Returns: Promise‹›

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Asset
src/api/entities/PermissionGroup.ts:19
src/api/entities/Entity.ts:48
src/api/entities/Entity.ts:46
src/api/entities/Entity.ts:68
src/api/entities/PermissionGroup.ts:35
Entity
src/api/entities/Entity.ts:61
src/api/entities/Entity.ts:73
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:42
src/api/entities/Entity.ts:23
Entity
KnownPermissionGroup
CustomPermissionGroup
asset
context
uuid
exists
getPermissions
isEqual
toHuman
generateUuid
isUniqueIdentifiers
unserialize
Entity
CheckpointSchedule
CheckpointSchedule
Entity
CheckpointSchedule
Entity
CheckpointSchedule
Entity
CheckpointSchedule
exists
toHuman
isUniqueIdentifiers
context
uuid
isEqual
generateUuid
unserialize
GroupPermissions
GroupPermissions