DividendDistribution
Class used to manage the dividend distribution functionality
Hierarchy
↳ DividendDistribution
Index
Constructors
Properties
Methods
Constructors
constructor
Create a new Dividend Distribution instance
Parameters:
Properties
amount
• amount: BigNumber
checkpointId
• checkpointId: string
claimedAmount
• claimedAmount: BigNumber
Protected
context
Protected
contextcreated
• created: Date
currency
• currency: string | null
expiry
• expiry: Date
index
• index: number
maturity
• maturity: Date
name
• name: string
reclaimed
• reclaimed: boolean
securityTokenId
• securityTokenId: string
securityTokenSymbol
• securityTokenSymbol: string
tokenholders
totalSupply
• totalSupply: BigNumber
totalWithheld
• totalWithheld: BigNumber
totalWithheldWithdrawn
• totalWithheldWithdrawn: BigNumber
uid
• uid: string
Methods
_refresh
Hydrate the Dividend Distribution entity
Parameters:
Returns: void
pullPayment
Pull payment from this dividend distribution to the current address
pushPayment
Push payment for this dividend distribution
toPojo
▸ 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
withdrawTaxes
Withdraw collected taxes from this dividend distribution
Static
generateId
Static
generateId▸ generateId(__namedParameters
: object): string
Generate the Dividend Distribution's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Returns: string
Static
unserialize
Static
unserializeUnserialize string to a Dividend Distribution object representation
Parameters:
Last updated