api.entities.Asset.Fungible.CorporateActions.Distributions - PolymeshAssociation/polymesh-sdk GitHub Wiki

@polymeshassociation/polymesh-sdk / api/entities/Asset/Fungible/CorporateActions/Distributions

api/entities/Asset/Fungible/CorporateActions/Distributions

Handles all Asset Distributions related functionality

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

Parameter	Type
`args`	`ConfigureDividendDistributionParams`
`opts?`	`ProcedureOpts`

required role:

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

get(): Promise<DistributionWithDetails[]>

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

getOne(args): Promise<DistributionWithDetails>

Retrieve a single Dividend Distribution associated to this Asset by its ID

Parameter	Type
`args`	{ `id`: `BigNumber`; }
`args.id`	`BigNumber`

if there is no Distribution with the passed ID