DividendDistribution

Class used to manage the dividend distribution functionality

Hierarchy

• Entity‹Params›

  ↳ DividendDistribution

Index

Constructors

• constructor

Properties

• amount

• checkpointId

• claimedAmount

• context

• created

• currency

• expiry

• index

• maturity

• name

• reclaimed

• securityTokenId

• securityTokenSymbol

• tokenholders

• totalSupply

• totalWithheld

• totalWithheldWithdrawn

• uid

Methods

• _refresh

• pullPayment

• pushPayment

• toPojo

• withdrawTaxes

• generateId

• unserialize

Constructors

constructor

+ new DividendDistribution(params: Params & UniqueIdentifiers, context: Context): DividendDistribution

Defined in src/entities/DividendDistribution.ts:146

Create a new Dividend Distribution instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers
context	Context

Returns: DividendDistribution

Properties

amount

• amount: BigNumber

Defined in src/entities/DividendDistribution.ts:128

checkpointId

• checkpointId: string

Defined in src/entities/DividendDistribution.ts:116

claimedAmount

• claimedAmount: BigNumber

Defined in src/entities/DividendDistribution.ts:130

Protected context

• context: Context

Defined in src/entities/DividendDistribution.ts:146

created

• created: Date

Defined in src/entities/DividendDistribution.ts:122

currency

• currency: string | null

Defined in src/entities/DividendDistribution.ts:144

expiry

• expiry: Date

Defined in src/entities/DividendDistribution.ts:126

index

• index: number

Defined in src/entities/DividendDistribution.ts:114

maturity

• maturity: Date

Defined in src/entities/DividendDistribution.ts:124

name

• name: string

Defined in src/entities/DividendDistribution.ts:142

reclaimed

• reclaimed: boolean

Defined in src/entities/DividendDistribution.ts:134

securityTokenId

• securityTokenId: string

Defined in src/entities/DividendDistribution.ts:120

securityTokenSymbol

• securityTokenSymbol: string

Defined in src/entities/DividendDistribution.ts:118

tokenholders

• tokenholders: DividendTokenholderStatus[]

Defined in src/entities/DividendDistribution.ts:140

totalSupply

• totalSupply: BigNumber

Defined in src/entities/DividendDistribution.ts:132

totalWithheld

• totalWithheld: BigNumber

Defined in src/entities/DividendDistribution.ts:136

totalWithheldWithdrawn

• totalWithheldWithdrawn: BigNumber

Defined in src/entities/DividendDistribution.ts:138

uid

• uid: string

Overrides Entity.uid

Defined in src/entities/DividendDistribution.ts:112

Methods

_refresh

▸ _refresh(params: Partial‹Params›): void

Overrides Entity._refresh

Defined in src/entities/DividendDistribution.ts:290

Hydrate the Dividend Distribution entity

Parameters:

Name	Type
params	Partial‹Params›

Returns: void

pullPayment

▸ pullPayment(): Promise‹TransactionQueue‹PullDividendPaymentProcedureArgs, void››

Defined in src/entities/DividendDistribution.ts:215

Pull payment from this dividend distribution to the current address

Returns: Promise‹TransactionQueue‹PullDividendPaymentProcedureArgs, void››

pushPayment

▸ pushPayment(): Promise‹TransactionQueue‹PushDividendPaymentProcedureArgs, void››

Defined in src/entities/DividendDistribution.ts:200

Push payment for this dividend distribution

Returns: Promise‹TransactionQueue‹PushDividendPaymentProcedureArgs, void››

toPojo

▸ toPojo(): object

Overrides Entity.toPojo

Defined in src/entities/DividendDistribution.ts:245

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

• tokenholders: DividendTokenholderStatus[]

• totalSupply: BigNumber

• totalWithheld: BigNumber

• totalWithheldWithdrawn: BigNumber

• uid: string

withdrawTaxes

▸ withdrawTaxes(): Promise‹TransactionQueue‹WithdrawTaxesProcedureArgs, void››

Defined in src/entities/DividendDistribution.ts:230

Withdraw collected taxes from this dividend distribution

Returns: Promise‹TransactionQueue‹WithdrawTaxesProcedureArgs, void››

Static generateId

▸ generateId(__namedParameters: object): string

Defined in src/entities/DividendDistribution.ts:87

Generate the Dividend Distribution's UUID from its identifying properties

Parameters:

▪ __namedParameters: object

Name	Type
index	number
securityTokenId	string

Returns: string

Static unserialize

▸ unserialize(serialized: string): UniqueIdentifiers

Defined in src/entities/DividendDistribution.ts:99

Unserialize string to a Dividend Distribution object representation

Parameters:

Name	Type
serialized	string

Returns: UniqueIdentifiers