CorporateAction
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents an action initiated by the issuer of an Asset which may affect the positions of the Asset Holders
↳
↳ CorporateAction
Asset affected by this Corporate Action
Protected context• context: Context
• declarationDate: Date
date at which the Corporate Action was created
• defaultTaxWithholding: BigNumber
default percentage (0-100) of tax withholding for this Corporate Action
• description: string
brief text description of the Corporate Action
• id: BigNumber
internal Corporate Action ID
Protected kindtype of corporate action being represented
Asset Holder Identities related to this Corporate action. If the treatment is Exclude, the Identities in the array will not be targeted by the Action, Identities not in the array will be targeted, and vice versa
percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage
• uuid: string
Retrieve the Checkpoint associated with this Corporate Action. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead. A null value means the Corporate Action was created without an associated Checkpoint
▸ exists(): Promise‹boolean›
Determine whether this Corporate Action exists on chain
Returns: Promise‹boolean›
Determine whether this Entity is the same as another one
Parameters:
entity
Returns: boolean
Link a list of documents to this corporate action
note any previous links are removed in favor of the new list
Parameters:
args
opts?
Modify the Corporate Action's Checkpoint
Parameters:
args
ModifyCaCheckpointParams
opts?
â–¸ toHuman(): HumanReadable
Return the Corporate Action's static data
Returns: HumanReadable
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
Parameters:
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
• asset:
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in
• kind:
Inherited from .
Defined in
• targets:
Inherited from .
Defined in
• taxWithholdings: []
Inherited from .
Defined in
Inherited from .
Defined in
▸ checkpoint(): Promise‹ | | null›
Inherited from .
Defined in
Returns: Promise‹ | | null›
Inherited from .
Overrides .
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
▸ linkDocuments(args: , opts?: ): Promise‹‹void››
Inherited from .
Defined in
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
Returns: Promise‹‹void››
▸ modifyCheckpoint(args: ModifyCaCheckpointParams, opts?: ): Promise‹‹void››
Overrides .
Defined in
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
Returns: Promise‹‹void››
Inherited from .
Overrides .
Defined in
Inherited from .
Defined in
Inherited from .
Defined in