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

Was this helpful?

  1. Classes

CustomPermissionGroup

PreviousCountNextDefaultPortfolio

Last updated 2 years ago

Was this helpful?

Represents a group of custom permissions for an Asset

Hierarchy

↳

↳ CustomPermissionGroup

Index

Properties

Methods

Properties

asset

Asset for which this group specifies permissions


Protected context

• context: Context


id

• id: BigNumber


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?


toHuman

â–¸ toHuman(): HumanReadable

Return the Group'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

• asset:

Inherited from .

Defined in

Inherited from .

Defined in

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 on it to see whether the signing Account and Identity have the required roles and permissions to run it

Returns: Promise‹‹void››

Overrides .

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/CustomPermissionGroup.ts:45
src/api/entities/Entity.ts:46
src/api/entities/CustomPermissionGroup.ts:106
src/api/entities/CustomPermissionGroup.ts:76
Entity
src/api/entities/Entity.ts:61
SetGroupPermissionsParams
ProcedureOpts
TransactionQueue
src/api/entities/CustomPermissionGroup.ts:69
ProcedureMethod
setPermissions.checkAuthorization
TransactionQueue
src/api/entities/CustomPermissionGroup.ts:124
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
PermissionGroup
asset
context
id
uuid
exists
getPermissions
isEqual
setPermissions
toHuman
generateUuid
unserialize
Entity
SetGroupPermissionsParams
ProcedureOpts
PermissionGroup
CheckpointSchedule
CheckpointSchedule
Entity
PermissionGroup
CheckpointSchedule
Entity
CheckpointSchedule
CheckpointSchedule
exists
toHuman
context
uuid
isEqual
generateUuid
unserialize
asset
getPermissions
GroupPermissions
GroupPermissions