api_entities_Asset_CorporateActions.CorporateActions
Previousapi_entities_Asset_Compliance_TrustedClaimIssuers.TrustedClaimIssuersNextapi_entities_Asset_CorporateActions_Distributions.Distributions
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / CorporateActions
.CorporateActions
Handles all Asset Corporate Actions related functionality
Namespace<>
↳ CorporateActions
Defined in
Retrieve a list of agent Identities
Returns
Defined in
Retrieve default config comprising of targets, global tax withholding percentage and per-Identity tax withholding percentages.
note This config is applied to every Corporate Action that is created until they are modified. Modifying the default config does not impact existing Corporate Actions. When creating a Corporate Action, values passed explicitly will override this default config
Returns
Defined in
â–¸ remove(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Remove a Corporate Action
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ removeAgent(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Remove the Corporate Actions Agent of the Asset
note this action will leave the Asset owner as the Corporate Actions Agent
deprecated
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ setAgent(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Assign a new Corporate Actions Agent for the Asset
deprecated in favor of inviteAgent
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ setDefaultConfig(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Assign default config values(targets, global tax withholding percentage and per-Identity tax withholding percentages)
note These config 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 default config values
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
• distributions:
â–¸ getAgents(): Promise<[]>
Promise<[]>
â–¸ getDefaultConfig(): Promise<>
Promise<>
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
note this may create which have to be accepted by the target Identity. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
note this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it