@polymeshassociation/polymesh-sdk / api/entities/Asset/Fungible/CorporateActions/Ballots

api/entities/Asset/Fungible/CorporateActions/Ballots

Classes

Ballots

Defined in: api/entities/Asset/Fungible/CorporateActions/Ballots.ts:21

Handles all Asset Ballots related functionality

Extends

• Namespace<FungibleAsset>

Methods

create()

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

Defined in: api/entities/Asset/Fungible/CorporateActions/Ballots.ts:25

Create a Ballot for an Asset

Parameters

Parameter	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

get()

get(): Promise<CorporateBallotWithDetails[]>

Defined in: api/entities/Asset/Fungible/CorporateActions/Ballots.ts:72

Retrieve all Ballots associated to this Asset

Returns

Promise<CorporateBallotWithDetails[]>

getOne()

getOne(args): Promise<CorporateBallotWithDetails>

Defined in: api/entities/Asset/Fungible/CorporateActions/Ballots.ts:45

Retrieve a single Ballot associated to this Asset by its ID

Parameters

Parameter	Type
args	{ id: BigNumber; }
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