CorporateActions
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Security Token Corporate Actions related functionality
Namespace‹›
↳ CorporateActions
Protected
contextInherited from void
Protected
parentInherited from void
Remove a Corporate Action
note
required role:
Corporate Actions Agent
• removeAgent: ProcedureMethod‹void, void›
Remove the Corporate Actions Agent of the Security Token
note
this action will leave the Security Token owner as the Corporate Actions Agent
note
required role:
Security Token Owner
Assign a new Corporate Actions Agent for the Security Token
param
identity to be set as Corporate Actions Agent
param
date at which the authorization request to modify the Corporate Actions Agent expires (optional, never expires if a date is not provided)
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
note
required role:
Security Token Owner
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
Retrieve the Security Token's Corporate Actions agent
Retrieve 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
• context:
Defined in
• distributions:
Defined in
• parent:
Defined in
• remove: ProcedureMethod‹, void›
Defined in
Defined in
• setAgent: ProcedureMethod‹, void›
Defined in
• setDefaults: ProcedureMethod‹, void›
Defined in
▸ getAgent(): Promise‹›
Defined in
Returns: Promise‹›
▸ getDefaults(): Promise‹›
Defined in
Returns: Promise‹›