Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • Methods
  • add
  • get
  • remove
  • set

Was this helpful?

  1. Classes

TrustedClaimIssuers

PreviousTransferRestrictionsNextVenue

Last updated 3 years ago

Was this helpful?

Handles all Security Token Default Trusted Claim Issuers related functionality

Hierarchy

  • Namespace‹›

    ↳ TrustedClaimIssuers

Index

Properties

Methods

Properties

Protected context

Inherited from void

Protected parent

Inherited from void

Methods

add

Add the supplied Identities to the Security Token's list of trusted claim issuers

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

get

Retrieve the current default trusted claim issuers of the Security Token

note can be subscribed to

Parameters:

Name

Type

callback

remove

Remove the supplied Identities from the Security Token's list of trusted claim issuers *

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

set

Assign a new default list of trusted claim issuers to the Security Token by replacing the existing ones with the list passed as a parameter

This requires two transactions

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

• context:

Defined in

• parent:

Defined in

▸ add(args: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

▸ get(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ get(callback: ‹[]›): Promise‹›

Defined in

‹[]›

Returns: Promise‹›

▸ remove(args: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

▸ set(args: ): Promise‹‹››

Defined in

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

Returns: Promise‹‹››

Context
src/api/entities/Namespace.ts:11
SecurityToken
src/api/entities/Namespace.ts:9
ModifyTokenTrustedClaimIssuersAddSetParams
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:96
ProcedureMethod
TransactionQueue
SecurityToken
DefaultTrustedClaimIssuer
src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:118
DefaultTrustedClaimIssuer
src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:119
ModifyTokenTrustedClaimIssuersRemoveParams
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:109
ProcedureMethod
TransactionQueue
SecurityToken
ModifyTokenTrustedClaimIssuersAddSetParams
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Compliance/TrustedClaimIssuers.ts:83
ProcedureMethod
TransactionQueue
SecurityToken
SecurityToken
context
parent
add
get
remove
set
ModifyTokenTrustedClaimIssuersAddSetParams
ModifyTokenTrustedClaimIssuersRemoveParams
ModifyTokenTrustedClaimIssuersAddSetParams
DefaultTrustedClaimIssuer
DefaultTrustedClaimIssuer
SubCallback
UnsubCallback
UnsubCallback
SubCallback