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

• configureDividendDistribution
• get
• getOne

Methods

configureDividendDistribution

▸ configureDividendDistribution(args, opts?): Promise<GenericPolymeshTransaction<DividendDistribution, DividendDistribution>>

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

Name	Type
args	ConfigureDividendDistributionParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<DividendDistribution, DividendDistribution>>

---

get

▸ get(): Promise<DistributionWithDetails[]>

Retrieve all Dividend Distributions associated to this Asset, along with their details

Returns

Promise<DistributionWithDetails[]>

---

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

Name	Type
args	Object
args.id	BigNumber

Returns

Promise<DistributionWithDetails>