Polymesh SDK API Reference
v11.0.2
v11.0.2
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • ticker
  • type
  • uuid
  • Methods
  • exists
  • getPermissions
  • isEqual
  • toJson
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

KnownPermissionGroup

PreviousIssuanceNextMiddleware

Last updated 3 years ago

Was this helpful?

Represents a pre-defined group of permissions for a Security Token

Hierarchy

↳

↳ KnownPermissionGroup

Index

Properties

Methods

Properties

Protected context

ticker

• ticker: string

type

uuid

• uuid: string

Methods

exists

▸ exists(): Promise‹boolean›

Determine whether this Known Permission Group exists on chain

Returns: Promise‹boolean›

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

toJson

▸ toJson(): HumanReadable

Return the KnownPermissionGroup's static data

Returns: HumanReadable

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 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

• context:

Inherited from .

Defined in

Inherited from .

Defined in

• type:

Defined in

Inherited from .

Defined in

Overrides .

Defined in

▸ getPermissions(): Promise‹›

Overrides .

Defined in

Returns: Promise‹›

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

Inherited from .

Defined in

‹unknown, unknown›

Overrides .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

PermissionGroup
context
ticker
type
uuid
exists
getPermissions
isEqual
toJson
generateUuid
unserialize
Context
Entity
context
src/api/entities/Entity.ts:48
PermissionGroup
ticker
src/api/entities/PermissionGroup.ts:27
PermissionGroupType
src/api/entities/KnownPermissionGroup.ts:30
Entity
uuid
src/api/entities/Entity.ts:46
Entity
exists
src/api/entities/KnownPermissionGroup.ts:90
GroupPermissions
PermissionGroup
getPermissions
src/api/entities/KnownPermissionGroup.ts:46
GroupPermissions
Entity
Entity
isEqual
src/api/entities/Entity.ts:61
Entity
toJson
src/api/entities/KnownPermissionGroup.ts:97
Entity
generateUuid
src/api/entities/Entity.ts:14
Entity
unserialize
src/api/entities/Entity.ts:23
Entity