Distributions
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Security Token Distributions related functionality
Namespace‹›
↳ Distributions
Protected
contextInherited from void
Protected
parentInherited from void
Create a Dividend Distribution for a subset of the Tokenholders at a certain (existing or future) Checkpoint
note
required role:
Origin Portfolio Custodian
Parameters:
args
opts?
Retrieve all Dividend Distributions associated to this Security Token, along with their details
Retrieve a single Dividend Distribution associated to this Security Token by its ID
throws
if there is no Distribution with the passed ID
Parameters:
▪ args: object
id
BigNumber
• context:
Defined in
• parent:
Defined in
▸ configureDividendDistribution(args
: , opts?
: ): Promise‹‹››
Defined in
note
this method is of type , which means you can call configureDividendDistribution.checkAuthorization
on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ get(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getOne(args
: object): Promise‹›
Defined in
Returns: Promise‹›