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

Was this helpful?

  1. Classes

Documents

PreviousDividendDistributionNextEntity

Last updated 3 years ago

Was this helpful?

Handles all Security Token Document related functionality

Hierarchy

  • Namespace‹›

    ↳ Documents

Index

Properties

Methods

Properties

Protected context

Inherited from void


Protected parent

Inherited from void

Methods

get

Retrieve all documents linked to the Security Token

note supports pagination

Parameters:

Name
Type

paginationOpts?


set

Assign a new list of documents to the Security Token by replacing the existing list of documents with the one passed in the parameters

This requires two transactions

Parameters:

Name
Type

args

opts?

• context:

Defined in

• parent:

Defined in

▸ get(paginationOpts?: ): Promise‹‹››

Defined in

Returns: Promise‹‹››

▸ set(args: , opts?: ): 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
PaginationOptions
ResultSet
TokenDocument
src/api/entities/SecurityToken/Documents.ts:49
ResultSet
TokenDocument
SetTokenDocumentsParams
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/Documents.ts:40
ProcedureMethod
TransactionQueue
SecurityToken
SecurityToken
context
parent
get
set
PaginationOptions
SetTokenDocumentsParams
ProcedureOpts