NumberedPortfolio
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a numbered (non-default) Portfolio for an Identity
↳
↳ NumberedPortfolio
Protected Optional _id• _id? : BigNumber
internal Portfolio identifier (unused for default Portfolio)
Protected context• id: BigNumber
portfolio identifier number
identity of the Portfolio's owner
• uuid: string
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
Delete this Portfolio
note required role:
Portfolio Custodian
Parameters:
Name
Type
args
void
opts?
▸ exists(): Promise‹boolean›
Return whether this Portfolio exists
Returns: Promise‹boolean›
Retrieve the custodian Identity of this Portfolio
note if no custodian is set, the owner Identity is returned
▸ getName(): Promise‹string›
Return the Portfolio name
Returns: Promise‹string›
Retrieve the balances of all assets in this Portfolio
Parameters:
Name
Type
args?
undefined | object
Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters
note supports pagination
note uses the middleware
Parameters:
â–ªDefault value filters: object= {}
Name
Type
Description
account?
undefined | string
account involved in the settlement
size?
undefined | number
page size
start?
undefined | number
page offset
ticker?
undefined | string
ticker involved in the transaction
▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›
Return whether an Identity is the Portfolio custodian
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹boolean›
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
▸ isOwnedBy(args?: undefined | object): Promise‹boolean›
Return whether an Identity is the Portfolio owner
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹boolean›
Rename portfolio
note required role:
Portfolio Custodian
Parameters:
Name
Type
args
opts?
Moves funds from this Portfolio to another one owned by the same Identity
note required role:
Portfolio Custodian
Parameters:
Name
Type
args
opts?
Returns the custody of the portfolio to the portfolio owner unilaterally
note required role:
Portfolio Custodian
Parameters:
Name
Type
args
void
opts?
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
note required role:
Portfolio Custodian
Parameters:
Name
Type
args
opts?
Return the Portfolio ID and owner DID
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Inherited from .
Defined in
• context:
Inherited from .
Defined in
Defined in
• owner:
Inherited from .
Defined in
Inherited from .
Defined in
▸ createdAt(): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
▸ delete(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call delete.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
Defined in
▸ getCustodian(): Promise‹›
Inherited from .
Defined in
Returns: Promise‹›
Defined in
▸ getTokenBalances(args?: undefined | object): Promise‹[]›
Inherited from .
Defined in
Returns: Promise‹[]›
▸ getTransactionHistory(filters: object): Promise‹‹››
Inherited from .
Defined in
Returns: Promise‹‹››
Inherited from .
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
Inherited from .
Defined in
▸ modifyName(args: , opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call modifyName.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ moveFunds(args: , opts?: ): Promise‹‹void››
Inherited from .
Defined in
note this method is of type , which means you can call moveFunds.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ quitCustody(args: void, opts?: ): Promise‹‹void››
Inherited from .
Defined in
note this method is of type , which means you can call quitCustody.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ setCustodian(args: , opts?: ): Promise‹‹void››
Inherited from .
Defined in
note this method is of type , which means you can call setCustodian.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
â–¸ toJson():
Inherited from .
Overrides .
Defined in
Returns:
Inherited from .
Defined in
Inherited from .
Defined in