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
  • id
  • ticker
  • uuid
  • Methods
  • exists
  • getPermissions
  • isEqual
  • setPermissions
  • toJson
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CustomPermissionGroup

PreviousCountNextDefaultPortfolio

Last updated 3 years ago

Was this helpful?

Represents a group of custom permissions for a Security Token

Hierarchy

↳

↳ CustomPermissionGroup

Index

Properties

Methods

Properties

Protected context


id

• id: BigNumber


ticker

• ticker: string


uuid

• uuid: string

Methods

exists

▸ exists(): Promise‹boolean›

Determine whether this Custom Permission Group exists on chain

Returns: Promise‹boolean›


getPermissions

Retrieve the list of permissions and transaction groups associated with this Permission Group


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


setPermissions

Modify the group's permissions

Parameters:

Name
Type

args

opts?


toJson

▸ toJson(): HumanReadable

Return the Group's ID

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

Defined in

Inherited from .

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›

▸ setPermissions(args: , opts?: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call setPermissions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

Overrides .

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

PermissionGroup
context
id
ticker
uuid
exists
getPermissions
isEqual
setPermissions
toJson
generateUuid
unserialize
Context
Entity
context
src/api/entities/Entity.ts:48
src/api/entities/CustomPermissionGroup.ts:45
PermissionGroup
ticker
src/api/entities/PermissionGroup.ts:27
Entity
uuid
src/api/entities/Entity.ts:46
Entity
exists
src/api/entities/CustomPermissionGroup.ts:117
GroupPermissions
PermissionGroup
getPermissions
src/api/entities/CustomPermissionGroup.ts:87
GroupPermissions
Entity
Entity
isEqual
src/api/entities/Entity.ts:61
SetGroupPermissionsParams
ProcedureOpts
TransactionQueue
src/api/entities/CustomPermissionGroup.ts:80
ProcedureMethod
TransactionQueue
Entity
toJson
src/api/entities/CustomPermissionGroup.ts:66
Entity
generateUuid
src/api/entities/Entity.ts:14
Entity
unserialize
src/api/entities/Entity.ts:23
Entity
SetGroupPermissionsParams
ProcedureOpts