Polymesh SDK API Reference
v9.0.0
v9.0.0
  • Introduction
  • 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
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • GroupedInstructions
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • Methods
  • enabledAt
  • get
  • getGroup
  • hasPermissions
  • setGroup
  • waive

Was this helpful?

  1. Classes

TokenPermissions

PreviousTokenHoldersNextTransactionQueue

Last updated 3 years ago

Was this helpful?

Handles all Token Permissions (External Agents) related functionality on the Identity side

Hierarchy

  • Namespace‹›

    ↳ TokenPermissions

Index

Properties

Methods

Properties

Protected context

Inherited from void

Protected parent

Inherited from void

Methods

enabledAt

Retrieve the identifier data (block number, date and event index) of the event that was emitted when this Identity was enabled/added as an Agent with permissions over a specific Security Token

note uses the middleware

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

Parameters:

▪ __namedParameters: object

Name

Type

token

get

Retrieve all the Security Tokens over which this Identity has permissions, with the corresponding Permission Group

getGroup

Retrieve this Identity's Permission Group for a specific Security Token

Parameters:

▪ __namedParameters: object

Name

Type

token

hasPermissions

▸ hasPermissions(args: object): Promise‹boolean›

Check whether this Identity has specific transaction Permissions over a Security Token

Parameters:

▪ args: object

Name

Type

token

transactions

TxTag[] | null

Returns: Promise‹boolean›

setGroup

Assign this Identity to a different Permission Group for a given Security Token

Parameters:

Name

Type

args

opts?

waive

Abdicate from the current Permissions Group for a given Security Token. This means that this Identity will no longer have any permissions over said Token

Parameters:

Name

Type

args

opts?

• context:

Defined in

• parent:

Defined in

▸ enabledAt(__namedParameters: object): Promise‹ | null›

Defined in

string | ‹›

Returns: Promise‹ | null›

▸ get(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getGroup(__namedParameters: object): Promise‹ | ›

Defined in

string | ‹›

Returns: Promise‹ | ›

Defined in

| string

▸ setGroup(args: , opts?: ): Promise‹‹ | ››

Defined in

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

Returns: Promise‹‹ | ››

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

Defined in

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

Returns: Promise‹‹void››

Context
src/api/entities/Namespace.ts:11
Identity
src/api/entities/Namespace.ts:9
EventIdentifier
src/api/entities/Identity/TokenPermissions.ts:264
EventIdentifier
TokenWithGroup
src/api/entities/Identity/TokenPermissions.ts:72
TokenWithGroup
CustomPermissionGroup
KnownPermissionGroup
src/api/entities/Identity/TokenPermissions.ts:224
CustomPermissionGroup
KnownPermissionGroup
src/api/entities/Identity/TokenPermissions.ts:101
SetPermissionGroupParams
ProcedureOpts
TransactionQueue
CustomPermissionGroup
KnownPermissionGroup
src/api/entities/Identity/TokenPermissions.ts:301
ProcedureMethod
TransactionQueue
CustomPermissionGroup
KnownPermissionGroup
WaivePermissionsParams
ProcedureOpts
TransactionQueue
src/api/entities/Identity/TokenPermissions.ts:291
ProcedureMethod
TransactionQueue
Identity
context
parent
enabledAt
get
getGroup
hasPermissions
setGroup
waive
SecurityToken
SecurityToken
SecurityToken
SetPermissionGroupParams
ProcedureOpts
WaivePermissionsParams
ProcedureOpts