api_entities_Identity_Portfolios.Portfolios
@polymeshassociation/polymesh-sdk / Modules / api/entities/Identity/Portfolios / Portfolios
Class: Portfolios
api/entities/Identity/Portfolios.Portfolios
Handles all Portfolio related functionality on the Identity side
Hierarchy
Namespace<Identity>↳
Portfolios
Table of contents
Methods
Methods
delete
▸ delete(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
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
| Name | Type |
|---|---|
|
|
|
|
|
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
api/entities/Identity/Portfolios.ts:164
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
| Name | Type |
|---|---|
|
Returns
Promise<ResultSet<NumberedPortfolio | DefaultPortfolio>>
Defined in
api/entities/Identity/Portfolios.ts:77
getPortfolio
▸ getPortfolio(): Promise<DefaultPortfolio>
Retrieve a Numbered Portfolio or the Default Portfolio if Portfolio ID is not passed
Returns
Promise<DefaultPortfolio>
Defined in
api/entities/Identity/Portfolios.ts:124
▸ getPortfolio(args): Promise<NumberedPortfolio>
Parameters
| Name | Type |
|---|---|
|
|
|
|
Returns
Promise<NumberedPortfolio>
Defined in
api/entities/Identity/Portfolios.ts:125
getPortfolios
▸ getPortfolios(): Promise<[DefaultPortfolio, ...NumberedPortfolio[]]>
Retrieve all the Portfolios owned by this Identity
Returns
Promise<[DefaultPortfolio, ...NumberedPortfolio[]]>
Defined in
Last updated