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
  • type
  • uuid
  • Methods
  • exists
  • getPermissions
  • isEqual
  • toHuman
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

KnownPermissionGroup

Represents a pre-defined group of permissions for an Asset

Hierarchy

↳ PermissionGroup

↳ KnownPermissionGroup

Index

Properties

  • asset

  • context

  • type

  • uuid

Methods

  • exists

  • getPermissions

  • isEqual

  • toHuman

  • generateUuid

  • unserialize

Properties

asset

• asset: Asset

Inherited from PermissionGroup.asset

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

Asset for which this group specifies permissions


Protected context

• context: Context

Inherited from CheckpointSchedule.context

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


type

• type: PermissionGroupType

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


uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

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

Methods

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

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

Determine whether this Known Permission Group exists on chain

Returns: Promise‹boolean›


getPermissions

▸ getPermissions(): Promise‹GroupPermissions›

Overrides PermissionGroup.getPermissions

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

Retrieve the Permissions associated with this Permission Group

Returns: Promise‹GroupPermissions›


isEqual

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

Inherited from CheckpointSchedule.isEqual

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

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


toHuman

▸ toHuman(): HumanReadable

Overrides Entity.toHuman

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

Return the KnownPermissionGroup's static data

Returns: HumanReadable


Static generateUuid

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

Inherited from CheckpointSchedule.generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string


Static unserialize

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

Inherited from CheckpointSchedule.unserialize

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

PreviousIssuanceNextNetwork

Last updated 2 years ago

Was this helpful?

‹unknown, unknown›

Entity