Portfolios

Handles all Portfolio related functionality on the Identity side

Hierarchy

• Namespace‹Identity›

  ↳ Portfolios

Index

Properties

• context

• parent

Methods

• create

• delete

• getCustodiedPortfolios

• getPortfolio

• getPortfolios

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

Protected parent

• parent: Identity

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

create

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

Defined in src/api/entities/Identity/Portfolios.ts:166

Create a new Portfolio for the Identity

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

Parameters:

▪ args: object

Name	Type
name	string

▪Optional opts: ProcedureOpts

Returns: Promise‹TransactionQueue‹NumberedPortfolio››

delete

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

Defined in src/api/entities/Identity/Portfolios.ts:179

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 Current Account has the required permissions to run it

Parameters:

▪ args: object

Name	Type
portfolio	BigNumber | NumberedPortfolio

▪Optional opts: ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

getCustodiedPortfolios

▸ getCustodiedPortfolios(paginationOpts?: PaginationOptions): Promise‹ResultSet‹DefaultPortfolio | NumberedPortfolio››

Defined in src/api/entities/Identity/Portfolios.ts:82

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
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹DefaultPortfolio | NumberedPortfolio››

getPortfolio

▸ getPortfolio(): Promise‹DefaultPortfolio›

Defined in src/api/entities/Identity/Portfolios.ts:129

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

Returns: Promise‹DefaultPortfolio›

▸ getPortfolio(args: object): Promise‹NumberedPortfolio›

Defined in src/api/entities/Identity/Portfolios.ts:130

Parameters:

▪ args: object

Name	Type
portfolioId	BigNumber

Returns: Promise‹NumberedPortfolio›

getPortfolios

▸ getPortfolios(): Promise‹[]›

Defined in src/api/entities/Identity/Portfolios.ts:51

Retrieve all the Portfolios owned by this Identity

Returns: Promise‹[]›