DividendDistribution
Last updated
Was this helpful?
Last updated
Was this helpful?
Class used to manage the dividend distribution functionality
‹›
↳ DividendDistribution
Create a new Dividend Distribution instance
Parameters:
Name
Type
params
context
• amount: BigNumber
• checkpointId: string
• claimedAmount: BigNumber
Protected context• created: Date
• currency: string | null
• expiry: Date
• index: number
• maturity: Date
• name: string
• reclaimed: boolean
• securityTokenId: string
• securityTokenSymbol: string
• totalSupply: BigNumber
• totalWithheld: BigNumber
• totalWithheldWithdrawn: BigNumber
• uid: string
Hydrate the Dividend Distribution entity
Parameters:
Name
Type
params
Returns: void
Pull payment from this dividend distribution to the current address
Push payment for this dividend distribution
â–¸ toPojo(): object
Convert entity to POJO (Plain Old Javascript Object)
Returns: object
amount: BigNumber
checkpointId: string
claimedAmount: BigNumber
created: Date
currency: null | string
expiry: Date
index: number
maturity: Date
name: string
reclaimed: boolean
securityTokenId: string
securityTokenSymbol: string
totalSupply: BigNumber
totalWithheld: BigNumber
totalWithheldWithdrawn: BigNumber
uid: string
Withdraw collected taxes from this dividend distribution
Static generateIdâ–¸ generateId(__namedParameters: object): string
Generate the Dividend Distribution's UUID from its identifying properties
Parameters:
â–ª __namedParameters: object
Name
Type
index
number
securityTokenId
string
Returns: string
Static unserializeUnserialize string to a Dividend Distribution object representation
Parameters:
Name
Type
serialized
string
+ new DividendDistribution(params: & , context: ):
Defined in
&
Returns:
Defined in
Defined in
Defined in
• context:
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
• tokenholders: []
Defined in
Defined in
Defined in
Defined in
Overrides .
Defined in
▸ _refresh(params: Partial‹›): void
Overrides .
Defined in
Partial‹›
▸ pullPayment(): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ pushPayment(): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
Overrides .
Defined in
tokenholders: []
▸ withdrawTaxes(): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
Defined in
â–¸ unserialize(serialized: string):
Defined in
Returns: