Portfolios
Handles all Portfolio related functionality on the Identity side
Hierarchy
Namespace‹Identity›
↳ Portfolios
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from void
Defined in src/api/entities/Namespace.ts:11
Protected parent
Protected parent• parent: Identity
Inherited from void
Defined in src/api/entities/Namespace.ts:9
Methods
create
▸ create(args: object): Promise‹TransactionQueue‹NumberedPortfolio››
Defined in src/api/entities/Identity/Portfolios.ts:119
Create a new Portfolio for the Identity
Parameters:
▪ args: object
Name
Type
name
string
Returns: Promise‹TransactionQueue‹NumberedPortfolio››
delete
▸ delete(args: object): Promise‹TransactionQueue‹void››
Defined in src/api/entities/Identity/Portfolios.ts:126
Delete a Portfolio by ID
Parameters:
▪ args: object
Name
Type
portfolio
BigNumber | NumberedPortfolio
Returns: Promise‹TransactionQueue‹void››
getCustodiedPortfolios
▸ getCustodiedPortfolios(): Promise‹(DefaultPortfolio‹› | NumberedPortfolio‹›)[]›
Defined in src/api/entities/Identity/Portfolios.ts:55
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
Returns: Promise‹(DefaultPortfolio‹› | NumberedPortfolio‹›)[]›
getPortfolio
▸ getPortfolio(args?: undefined | object): Promise‹DefaultPortfolio | NumberedPortfolio›
Defined in src/api/entities/Identity/Portfolios.ts:89
Retrieve a numbered Portfolio or the default Portfolio if Portfolio ID is not passed
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹DefaultPortfolio | NumberedPortfolio›
getPortfolios
▸ getPortfolios(): Promise‹[DefaultPortfolio, NumberedPortfolio]›
Defined in src/api/entities/Identity/Portfolios.ts:24
Retrieve all the Portfolios owned by this Identity
Returns: Promise‹[DefaultPortfolio, NumberedPortfolio]›
Last updated