Distributions
Handles all Asset Distributions related functionality
Hierarchy
Namespace‹Asset›
↳ Distributions
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from void
Defined in src/api/entities/Namespace.ts:11
Protected parent
Protected parent• parent: Asset
Inherited from void
Defined in src/api/entities/Namespace.ts:9
Methods
configureDividendDistribution
▸ configureDividendDistribution(args: ConfigureDividendDistributionParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹DividendDistribution››
Defined in src/api/entities/Asset/CorporateActions/Distributions.ts:39
Create a Dividend Distribution for a subset of the Asset Holders at a certain (existing or future) Checkpoint
note required role:
Origin Portfolio Custodian
note this method is of type ProcedureMethod, which means you can call configureDividendDistribution.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹DividendDistribution››
get
▸ get(): Promise‹DistributionWithDetails[]›
Defined in src/api/entities/Asset/CorporateActions/Distributions.ts:114
Retrieve all Dividend Distributions associated to this Asset, along with their details
Returns: Promise‹DistributionWithDetails[]›
getOne
▸ getOne(args: object): Promise‹DistributionWithDetails›
Defined in src/api/entities/Asset/CorporateActions/Distributions.ts:62
Retrieve a single Dividend Distribution associated to this Asset by its ID
throws if there is no Distribution with the passed ID
Parameters:
▪ args: object
Returns: Promise‹DistributionWithDetails›
Last updated