NumberedPortfolio
Represents a numbered (non-default) Portfolio for an Identity
Hierarchy
↳ NumberedPortfolio
Index
Properties
Methods
Properties
Protected Optional _id
Protected Optional _id• _id? : BigNumber
Defined in src/api/entities/Portfolio/index.ts:53
internal Portfolio identifier (unused for default Portfolio)
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
id
• id: BigNumber
Defined in src/api/entities/NumberedPortfolio.ts:38
portfolio identifier number
owner
• owner: Identity
Inherited from Portfolio.owner
Defined in src/api/entities/Portfolio/index.ts:48
identity of the Portfolio's owner
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
createdAt
▸ createdAt(): Promise‹EventIdentifier | null›
Defined in src/api/entities/NumberedPortfolio.ts:102
Retrieve the identifier data (block number, date and event index) of the event that was emitted when this portfolio was created
note uses the middleware
note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned
Returns: Promise‹EventIdentifier | null›
delete
▸ delete(): Promise‹TransactionQueue‹void››
Defined in src/api/entities/NumberedPortfolio.ts:54
Delete this Portfolio
Returns: Promise‹TransactionQueue‹void››
exists
▸ exists(): Promise‹boolean›
Defined in src/api/entities/NumberedPortfolio.ts:135
Return whether this Portfolio exists
Returns: Promise‹boolean›
getCustodian
▸ getCustodian(): Promise‹Identity›
Inherited from Portfolio.getCustodian
Defined in src/api/entities/Portfolio/index.ts:199
Retrieve the custodian Identity of this Portfolio
note if no custodian is set, the owner Identity is returned
Returns: Promise‹Identity›
getName
▸ getName(): Promise‹string›
Defined in src/api/entities/NumberedPortfolio.ts:79
Return the Portfolio name
Returns: Promise‹string›
getTokenBalances
▸ getTokenBalances(args?: undefined | object): Promise‹PortfolioBalance[]›
Inherited from Portfolio.getTokenBalances
Defined in src/api/entities/Portfolio/index.ts:104
Retrieve the balances of all assets in this Portfolio
Parameters:
Name | Type |
| undefined | object |
Returns: Promise‹PortfolioBalance[]›
isCustodiedBy
▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›
Inherited from Portfolio.isCustodiedBy
Defined in src/api/entities/Portfolio/index.ts:88
Return whether an Identity is the Portfolio custodian
Parameters:
Name | Type |
| undefined | object |
Returns: Promise‹boolean›
isOwnedBy
▸ isOwnedBy(args?: undefined | object): Promise‹boolean›
Inherited from Portfolio.isOwnedBy
Defined in src/api/entities/Portfolio/index.ts:72
Return whether an Identity is the Portfolio owner
Parameters:
Name | Type |
| undefined | object |
Returns: Promise‹boolean›
modifyName
▸ modifyName(args: RenamePortfolioParams): Promise‹TransactionQueue‹NumberedPortfolio››
Defined in src/api/entities/NumberedPortfolio.ts:65
Rename portfolio
Parameters:
Name | Type |
|
Returns: Promise‹TransactionQueue‹NumberedPortfolio››
moveFunds
▸ moveFunds(args: MoveFundsParams): Promise‹TransactionQueue‹void››
Inherited from Portfolio.moveFunds
Defined in src/api/entities/Portfolio/index.ts:190
Moves funds from this Portfolio to another one owned by the same Identity
Parameters:
Name | Type |
|
Returns: Promise‹TransactionQueue‹void››
setCustodian
▸ setCustodian(args: SetCustodianParams): Promise‹TransactionQueue‹void››
Inherited from Portfolio.setCustodian
Defined in src/api/entities/Portfolio/index.ts:174
Send an invitation to an Identity to assign it as custodian for this Portfolio
note this may create an AuthorizationRequest which has to be accepted by the corresponding Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived
Parameters:
Name | Type |
|
Returns: Promise‹TransactionQueue‹void››
Static generateUuid
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Defined in src/api/entities/Entity.ts:14
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers: object
Parameters:
Name | Type | Description |
| Identifiers |
Returns: string
Static unserialize
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Defined in src/api/entities/Entity.ts:23
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers: object
Parameters:
Name | Type | Description |
| string | UUID to unserialize |
Returns: Identifiers
Last updated