WithdrawTaxes

Procedure that allows an issuer to withdraw withheld tax from a Dividend Distribution

Type parameters

ReturnType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new WithdrawTaxes(args: WithdrawTaxesProcedureArgs, context: Context): WithdrawTaxes

Inherited from void

Defined in src/procedures/Procedure.ts:40

Parameters:

Name

Type

args

WithdrawTaxesProcedureArgs

context

Context

Returns: WithdrawTaxes

Properties

Protected args

args: WithdrawTaxesProcedureArgs

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.WithdrawTaxes

Overrides void

Defined in src/procedures/WithdrawTaxes.ts:28

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

addSignatureRequest<A>(request: SignatureRequest‹A›): (Anonymous function)

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

SignatureRequest‹A›

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

Returns: (Anonymous function)

a PostTransactionResolver that resolves to the signed data

addTransaction

addTransaction<A, R, V>(method: LowLevelMethod‹A› | FutureLowLevelMethod‹V, A›, __namedParameters: object): (Anonymous function)

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:

method: LowLevelMethod‹A› | FutureLowLevelMethod‹V, A›

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= {}

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/WithdrawTaxes.ts:37

Withdraw Tax Withholdings

Note that this procedure will fail if:

  • The security token doesn't exist

  • The Dividends Feature hasn't been enabled

Returns: Promise‹void›