api.entities.Asset.Fungible.CorporateActions.Ballots.Ballots

Class: Ballots

api/entities/Asset/Fungible/CorporateActions/Ballots.Ballots

Handles all Asset Ballots related functionality

Hierarchy

• Namespace<FungibleAsset>

  ↳ Ballots

Table of contents

Methods

• create
• get
• getOne

Methods

create

▸ create(args, opts?): Promise<GenericPolymeshTransaction<CorporateBallotWithDetails, CorporateBallotWithDetails>>

Create a Ballot for an Asset

Parameters

Name	Type
args	CreateBallotParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<CorporateBallotWithDetails, CorporateBallotWithDetails>>

Note

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

Defined in

api/entities/Asset/Fungible/CorporateActions/Ballots.ts:29

---

get

▸ get(): Promise<CorporateBallotWithDetails[]>

Retrieve all Ballots associated to this Asset

Returns

Promise<CorporateBallotWithDetails[]>

Defined in

api/entities/Asset/Fungible/CorporateActions/Ballots.ts:78

---

getOne

▸ getOne(args): Promise<CorporateBallotWithDetails>

Retrieve a single Ballot associated to this Asset by its ID

Parameters

Name	Type
args	Object
args.id	BigNumber

Returns

Promise<CorporateBallotWithDetails>

Throws

if there is no Ballot assigned to the provided Corporate Action with the passed ID

Throws

if the provided Corporate Action does not exist

Defined in

api/entities/Asset/Fungible/CorporateActions/Ballots.ts:51