CorporateActions

Handles all Security Token Corporate Actions related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

distributions

distributions: Distributions

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:37

Protected parent

parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

getAgents

getAgents(): Promise‹Identity[]›

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:127

Retrieve a list of agent identities

Returns: Promise‹Identity[]›

getDefaults

getDefaults(): Promise‹CorporateActionDefaults

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:162

Retrieve default values for targets, global tax withholding percentage and per-identity tax withholding percentages.

note These values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these defaults

Returns: Promise‹CorporateActionDefaults

remove

remove(args: RemoveCorporateActionParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:120

Remove a Corporate Action

note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

removeAgent

removeAgent(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:110

Remove the Corporate Actions Agent of the Security Token

note this action will leave the Security Token owner as the Corporate Actions Agent

deprecated

note this method is of type ProcedureMethod, which means you can call removeAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

setAgent

setAgent(args: ModifyCorporateActionsAgentParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:96

Assign a new Corporate Actions Agent for the Security Token

note this may create AuthorizationRequests which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

deprecated in favor of inviteAgent

note this method is of type ProcedureMethod, which means you can call setAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

setDefaults

setDefaults(args: ModifyCaDefaultsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/CorporateActions/index.ts:80

Assign default values for targets, global tax withholding percentage and per-identity tax withholding perecentages.

note These values are applied to every Corporate Action that is created until they are modified. Modifying these values does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override these defaults

note this method is of type ProcedureMethod, which means you can call setDefaults.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

Last updated