Skip to main content
Version: 23.0.x

Class: Portfolios

api/entities/Identity/Portfolios.Portfolios

Handles all Portfolio related functionality on the Identity side

Hierarchy

Methods

delete

delete(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Delete a Portfolio by ID

Note

required role:

  • Portfolio Custodian

Note

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

Parameters

NameType
argsObject
args.portfolioBigNumber | NumberedPortfolio
opts?ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>


getCustodiedPortfolios

getCustodiedPortfolios(paginationOpts?): Promise<ResultSet<NumberedPortfolio | DefaultPortfolio>>

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 getPortfolios

Note

supports pagination

Parameters

NameType
paginationOpts?PaginationOptions

Returns

Promise<ResultSet<NumberedPortfolio | DefaultPortfolio>>


getPortfolio

getPortfolio(): Promise<DefaultPortfolio>

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

Returns

Promise<DefaultPortfolio>

getPortfolio(args): Promise<NumberedPortfolio>

Parameters

NameType
argsObject
args.portfolioIdBigNumber

Returns

Promise<NumberedPortfolio>


getPortfolios

getPortfolios(): Promise<[DefaultPortfolio, ...NumberedPortfolio[]]>

Retrieve all the Portfolios owned by this Identity

Returns

Promise<[DefaultPortfolio, ...NumberedPortfolio[]]>