api_entities_Asset_CorporateActions_Distributions.Distributions
Previousapi_entities_Asset_CorporateActions.CorporateActionsNextapi_entities_Asset_Documents.Documents
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Distributions
.Distributions
Handles all Asset Distributions related functionality
Namespace<>
↳ Distributions
Create a Dividend Distribution for a subset of the Asset Holders at a certain (existing or future) Checkpoint
note required role:
Origin Portfolio Custodian
Parameters
args
opts?
Returns
Defined in
Retrieve all Dividend Distributions associated to this Asset, along with their details
Returns
Defined in
Retrieve a single Dividend Distribution associated to this Asset by its ID
throws if there is no Distribution with the passed ID
Parameters
args
Object
args.id
BigNumber
Returns
Defined in
▸ configureDividendDistribution(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Promise<TransactionQueue<, , unknown[][]>>
▸ get(): Promise<[]>
Promise<[]>
▸ getOne(args): Promise<>
Promise<>