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
  • create
  • delete
  • getCustodiedPortfolios
  • getPortfolio
  • getPortfolios

Was this helpful?

  1. Classes

Portfolios

PreviousPortfolioNextRequirements

Last updated 3 years ago

Was this helpful?

Handles all Portfolio related functionality on the Identity side

Hierarchy

  • Namespace‹›

    ↳ Portfolios

Index

Properties

Methods

Properties

Protected context

Inherited from void


Protected parent

Inherited from void

Methods

create

Create a new Portfolio for the Identity

Parameters:

▪ args: object

Name
Type

name

string


delete

Delete a Portfolio by ID

note required role:

  • Portfolio Custodian

Parameters:

▪ args: object

Name
Type

portfolio


getCustodiedPortfolios

note supports pagination

Parameters:

Name
Type

paginationOpts?


getPortfolio

Retrieve a Numbered Portfolio or the Default Portfolio if Portfolio ID is not passed

Parameters:

▪ args: object

Name
Type

portfolioId

BigNumber


getPortfolios

▸ getPortfolios(): Promise‹[]›

Retrieve all the Portfolios owned by this Identity

Returns: Promise‹[]›

• context:

Defined in

• parent:

Defined in

▸ create(args: object, opts?: ): Promise‹‹››

Defined in

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

▪Optional opts:

Returns: Promise‹‹››

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

Defined in

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

BigNumber |

▪Optional opts:

Returns: Promise‹‹void››

▸ getCustodiedPortfolios(paginationOpts?: ): Promise‹‹ | ››

Defined in

Retrieve all Portfolios custodied by this Identity. This only includes portfolios owned by a different Identity but custodied by this one. To fetch Portfolios owned by this Identity, use

Returns: Promise‹‹ | ››

▸ getPortfolio(): Promise‹›

Defined in

Returns: Promise‹›

▸ getPortfolio(args: object): Promise‹›

Defined in

Returns: Promise‹›

Defined in

Context
src/api/entities/Namespace.ts:11
Identity
src/api/entities/Namespace.ts:9
ProcedureOpts
TransactionQueue
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:166
ProcedureMethod
ProcedureOpts
TransactionQueue
NumberedPortfolio
ProcedureOpts
TransactionQueue
src/api/entities/Identity/Portfolios.ts:179
ProcedureMethod
ProcedureOpts
TransactionQueue
PaginationOptions
ResultSet
DefaultPortfolio
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:82
ResultSet
DefaultPortfolio
NumberedPortfolio
DefaultPortfolio
src/api/entities/Identity/Portfolios.ts:129
DefaultPortfolio
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:130
NumberedPortfolio
src/api/entities/Identity/Portfolios.ts:51
Identity
context
parent
create
delete
getCustodiedPortfolios
getPortfolio
getPortfolios
getPortfolios
NumberedPortfolio
PaginationOptions