api/entities/CorporateBallot.CorporateBallot

Represents a Ballot

• CorporateActionBase

  ↳ CorporateBallot

• asset
• declarationDate
• defaultTaxWithholding
• description
• id
• targets
• taxWithholdings
• uuid

• checkpoint
• details
• exists
• isEqual
• linkDocuments
• modifyCheckpoint
• remove
• results
• status
• toHuman
• vote
• votesByIdentity
• generateUuid
• unserialize

• asset: FungibleAsset

Asset affected by this Corporate Action

CorporateActionBase.asset

api/entities/CorporateActionBase/index.ts:80

---

• declarationDate: Date

date at which the Corporate Action was created

CorporateActionBase.declarationDate

api/entities/CorporateActionBase/index.ts:85

---

• defaultTaxWithholding: BigNumber

default percentage (0-100) of tax withholding for this Corporate Action

CorporateActionBase.defaultTaxWithholding

api/entities/CorporateActionBase/index.ts:101

---

• description: string

brief text description of the Corporate Action

CorporateActionBase.description

api/entities/CorporateActionBase/index.ts:90

---

• id: BigNumber

internal Corporate Action ID

CorporateActionBase.id

api/entities/CorporateActionBase/index.ts:75

---

• targets: CorporateActionTargets

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

CorporateActionBase.targets

api/entities/CorporateActionBase/index.ts:96

---

• taxWithholdings: TaxWithholding[]

percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

CorporateActionBase.taxWithholdings

api/entities/CorporateActionBase/index.ts:107

---

• uuid: string

CorporateActionBase.uuid

api/entities/Entity.ts:46

▸ checkpoint(): Promise<null | CheckpointSchedule | Checkpoint>

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

Promise<null | CheckpointSchedule | Checkpoint>

CorporateActionBase.checkpoint

api/entities/CorporateActionBase/index.ts:191

---

▸ details(): Promise<CorporateBallotDetails>

Retrieve details associated with this Ballot

Promise<CorporateBallotDetails>

Throws

if the Ballot does not exist

api/entities/CorporateBallot/index.ts:136

---

▸ exists(): Promise<boolean>

Determine whether this Ballot exists on chain

Promise<boolean>

CorporateActionBase.exists

api/entities/CorporateBallot/index.ts:115

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

CorporateActionBase.isEqual

api/entities/Entity.ts:61

---

▸ linkDocuments(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Link a list of documents to this corporate action

Name	Type
args	LinkCaDocsParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

Note

any previous links are removed in favor of the new list

Note

this method is of type ProcedureMethod, which means you can call linkDocuments.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

CorporateActionBase.linkDocuments

api/entities/CorporateActionBase/index.ts:160

---

▸ modifyCheckpoint(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Modify the Corporate Ballot's Record Date

Name	Type
args	Object
args.checkpoint	InputCaCheckpoint
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call modifyCheckpoint.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

CorporateActionBase.modifyCheckpoint

api/entities/CorporateBallot/index.ts:336

---

▸ remove(opts?): Promise<GenericPolymeshTransaction<void, void>>

Remove the Ballot

Name	Type
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

Note

deletes the corporate action with the associated ballot if ballot has not started

Throws

if ballot has already started

Throws

if ballot is not found

Note

this method is of type NoArgsProcedureMethod, 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

api/entities/CorporateBallot/index.ts:308

---

▸ results(): Promise<CorporateBallotMetaWithResults>

Retrieve the results of the Ballot

Promise<CorporateBallotMetaWithResults>

Throws

if the Ballot does not exist

api/entities/CorporateBallot/index.ts:173

---

▸ status(): Promise<CorporateBallotStatus>

Return the status of the Ballot

Promise<CorporateBallotStatus>

Throws

if the Ballot does not exist

api/entities/CorporateBallot/index.ts:147

---

▸ toHuman(): HumanReadable

Return the Corporate Action's static data

HumanReadable

CorporateActionBase.toHuman

api/entities/CorporateActionBase/index.ts:271

---

▸ vote(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Cast a vote on the Ballot

Name	Type
args	CastBallotVoteParams
opts?	ProcedureOpts

Promise<GenericPolymeshTransaction<void, void>>

Throws

if the Ballot does not exist

Throws

if the Ballot voting is not active

Throws

if the number of votes does not match the sum of all choices of all motions

Throws

if fallback votes are provided for a non-RCV Ballot

Throws

if vote does not point to the correct choice in motion

Throws

if the fallback vote is the same as the choice

Throws

if the fallback vote is not pointing to a choice in the motion

Note

this method is of type ProcedureMethod, which means you can call vote.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

api/entities/CorporateBallot/index.ts:326

---

▸ votesByIdentity(did): Promise<CorporateBallotWithParticipation>

Retrieve the participation of the Ballot

Name	Type
did	string | Identity

Promise<CorporateBallotWithParticipation>

Throws

if the Ballot does not exist

api/entities/CorporateBallot/index.ts:233

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

CorporateActionBase.generateUuid

api/entities/Entity.ts:14

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

CorporateActionBase.unserialize

api/entities/Entity.ts:23