PullDividendPayment

Procedure that allows a tokenholder to pull their dividend payments from a Dividend Distribution

Type parameters

▪ ReturnType

Hierarchy

• Procedure‹PullDividendPaymentProcedureArgs›

  ↳ PullDividendPayment

Index

Constructors

• constructor

Properties

• args

• context

• type

Methods

• addProcedure

• addSignatureRequest

• addTransaction

• prepare

• prepareTransactions

Constructors

constructor

+ new PullDividendPayment(args: PullDividendPaymentProcedureArgs, context: Context): PullDividendPayment

Inherited from void

Defined in src/procedures/Procedure.ts:40

Parameters:

Name	Type
args	PullDividendPaymentProcedureArgs
context	Context

Returns: PullDividendPayment

Properties

Protected args

• args: PullDividendPaymentProcedureArgs

Inherited from void

Defined in src/procedures/Procedure.ts:34

Protected context

• context: Context

Inherited from void

Defined in src/procedures/Procedure.ts:36

type

• type: ProcedureType = ProcedureType.PullDividendPayment

Overrides void

Defined in src/procedures/PullDividendPayment.ts:33

Methods

addProcedure

▸ addProcedure<A, R>(Proc: ProcedureClass‹A, R›): (Anonymous function)

Inherited from void

Defined in src/procedures/Procedure.ts:91

Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

Type parameters:

▪ A

▪ R: any

Parameters:

Name	Type	Description
Proc	ProcedureClass‹A, R›	A Procedure that will be run in the Procedure's TransactionQueue

Returns: (Anonymous function)

whichever value is returned by the Procedure

addSignatureRequest

Inherited from void

Defined in src/procedures/Procedure.ts:179

Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

Type parameters:

▪ A

Parameters:

Name	Type	Description
request		A signature request that will be run in the Procedure's TransactionQueue

Returns: (Anonymous function)

a PostTransactionResolver that resolves to the signed data

addTransaction

Inherited from void

Defined in src/procedures/Procedure.ts:137

Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.

Type parameters:

▪ A

▪ R: any[]

▪ V: any

Parameters:

A method (or future method) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time (for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run)

▪Default value __namedParameters: object= {}

Name	Type	Default
fees	undefined | Fees	-
resolvers	object	([] as unknown) as ResolverArray
tag		-

Returns: (Anonymous function)

a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed

prepare

▸ prepare(): Promise‹TransactionQueue‹Args, ReturnType››

Inherited from void

Defined in src/procedures/Procedure.ts:52

Mandatory method that builds a list of transactions that will be run

Returns: Promise‹TransactionQueue‹Args, ReturnType››

prepareTransactions

▸ prepareTransactions(): Promise‹void›

Overrides void

Defined in src/procedures/PullDividendPayment.ts:44

Pull dividend payments from the Dividend Distribution

Note this procedure will fail if:

• The Dividends Feature is not enabled

• The current wallet address is not a tokenholder

• The current wallet address has already received payment for this Dividend Distribution

• The current wallet address is on the exclusion list

Returns: Promise‹void›