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
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
Remove a Corporate Action
note required role:
Corporate Actions Agent
Parameters:
Name
Type
args
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
Parameters:
Name
Type
args
void
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
note required role:
Security Token Owner
Parameters:
Name
Type
args
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
Parameters:
Name
Type
args
• context:
Defined in
• distributions:
Defined in
• parent:
Defined in
▸ getAgent(): Promise‹›
Defined in
Returns: Promise‹›
▸ getDefaults(): Promise‹›
Defined in
Returns: Promise‹›
▸ remove(args: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ removeAgent(args: void): Promise‹‹void››
Defined in
note this method is of type , which means you can call removeAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ setAgent(args: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call setAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ setDefaults(args: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call setDefaults.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››