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
  • Protected context
  • Protected parent
  • Methods
  • add
  • get
  • remove
  • set

Was this helpful?

  1. Classes

TrustedClaimIssuers

Handles all Asset Default Trusted Claim Issuers related functionality

Hierarchy

  • Namespace‹Asset›

    ↳ TrustedClaimIssuers

Index

Properties

  • context

  • parent

Methods

  • add

  • get

  • remove

  • set

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11


Protected parent

• parent: Asset

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

add

▸ add(args: ModifyAssetTrustedClaimIssuersAddSetParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/TrustedClaimIssuers.ts:91

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

note this method is of type ProcedureMethod, which means you can call add.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹Asset››


get

▸ get(): Promise‹TrustedClaimIssuer‹true›[]›

Defined in src/api/entities/Asset/Compliance/TrustedClaimIssuers.ts:110

Retrieve the current Default Trusted Claim Issuers of the Asset

note can be subscribed to

Returns: Promise‹TrustedClaimIssuer‹true›[]›

▸ get(callback: SubCallback‹TrustedClaimIssuer‹true›[]›): Promise‹UnsubCallback›

Defined in src/api/entities/Asset/Compliance/TrustedClaimIssuers.ts:111

Parameters:

Name
Type

callback

Returns: Promise‹UnsubCallback›


remove

▸ remove(args: ModifyAssetTrustedClaimIssuersRemoveParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/TrustedClaimIssuers.ts:101

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

note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹Asset››


set

▸ set(args: ModifyAssetTrustedClaimIssuersAddSetParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Compliance/TrustedClaimIssuers.ts:81

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

This requires two transactions

note this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name
Type

args

opts?

Returns: Promise‹TransactionQueue‹Asset››

PreviousTransferRestrictionsNextVenue

Last updated 2 years ago

Was this helpful?

‹‹true›[]›

ModifyAssetTrustedClaimIssuersAddSetParams
ProcedureOpts
SubCallback
TrustedClaimIssuer
ModifyAssetTrustedClaimIssuersRemoveParams
ProcedureOpts
ModifyAssetTrustedClaimIssuersAddSetParams
ProcedureOpts