api.entities.Asset.Fungible.CorporateActions - PolymeshAssociation/polymesh-sdk GitHub Wiki
@polymeshassociation/polymesh-sdk / api/entities/Asset/Fungible/CorporateActions
api/entities/Asset/Fungible/CorporateActions
Classes
CorporateActions
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:31
Handles all Asset Corporate Actions related functionality
Extends
Namespace<FungibleAsset>
Properties
ballots
ballots:
Ballots
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:33
distributions
distributions:
Distributions
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:32
initiate
initiate:
ProcedureMethod<InitiateCorporateActionParams,CorporateAction>
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:148
Methods
getAgents()
getAgents():
Promise<Identity[]>
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:77
Retrieve a list of agent Identities
Returns
Promise<Identity[]>
getDefaultConfig()
getDefaultConfig():
Promise<CorporateActionDefaultConfig>
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:113
Retrieve default config comprising of targets, global tax withholding percentage and per-Identity tax withholding percentages.
Returns
Promise<CorporateActionDefaultConfig>
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
remove()
remove(
args,opts?):Promise<GenericPolymeshTransaction<void,void>>
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:72
Remove a Corporate Action
Parameters
| Parameter | Type |
|---|---|
args |
RemoveCorporateActionParams |
opts? |
ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
Note
this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
setDefaultConfig()
setDefaultConfig(
args,opts?):Promise<GenericPolymeshTransaction<void,void>>
Defined in: api/entities/Asset/Fungible/CorporateActions/index.ts:67
Assign default config values(targets, global tax withholding percentage and per-Identity tax withholding percentages)
Parameters
| Parameter | Type |
|---|---|
args |
ModifyCaDefaultConfigParams |
opts? |
ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<void, void>>
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
Note
this method is of type ProcedureMethod, which means you can call setDefaultConfig.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it