api_entities_Asset_CorporateActions_Distributions.Distributions
@polymeshassociation/polymesh-sdk / Modules / api/entities/Asset/CorporateActions/Distributions / Distributions
Class: Distributions
api/entities/Asset/CorporateActions/Distributions.Distributions
Handles all Asset Distributions related functionality
Hierarchy
Namespace<Asset>↳
Distributions
Table of contents
Methods
Methods
configureDividendDistribution
▸ configureDividendDistribution(args, opts?): Promise<TransactionQueue<DividendDistribution, DividendDistribution, unknown[][]>>
Create a Dividend Distribution for a subset of the Asset Holders at a certain (existing or future) Checkpoint
note required role:
Origin Portfolio Custodian
note this method is of type ProcedureMethod, which means you can call configureDividendDistribution.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters
Returns
Promise<TransactionQueue<DividendDistribution, DividendDistribution, unknown[][]>>
Defined in
api/entities/Asset/CorporateActions/Distributions.ts:39
get
▸ get(): Promise<DistributionWithDetails[]>
Retrieve all Dividend Distributions associated to this Asset, along with their details
Returns
Promise<DistributionWithDetails[]>
Defined in
api/entities/Asset/CorporateActions/Distributions.ts:114
getOne
▸ getOne(args): Promise<DistributionWithDetails>
Retrieve a single Dividend Distribution associated to this Asset by its ID
throws if there is no Distribution with the passed ID
Parameters
Returns
Promise<DistributionWithDetails>
Defined in
Last updated