Struct polymesh_api::polymesh::api::corporate_ballot::CallApi

source · [−]

pub struct CallApi<'api> { /* private fields */ }

Implementations

source

impl<'api> CallApi<'api>

source

pub fn attach_ballot(
 &self,
 ca_id: CAId,
 range: BallotTimeRange,
 meta: BallotMeta,
 rcv: bool
) -> Result<WrappedCall<'api>>

Attach a corporate ballot to the CA identified by ca_id.

The ballot will admit votes within range. The ballot’s metadata is provided by meta, which includes the ballot title, the motions, their choices, etc. See the BallotMeta for more.

Arguments

origin is a signer that has permissions to act as an agent of ca_id.ticker.
ca_id identifies the CA to attach the ballot to.
range specifies when voting starts and ends.
meta specifies the ballot’s metadata as aforementioned.
rcv specifies whether RCV is enabled for this ballot.

Errors

UnauthorizedAgent if origin is not agent-permissioned for ticker.
NoSuchCA if ca_id does not identify an existing CA.
CANotNotice if the CA is not of the IssuerNotice kind.
StartAfterEnd if range.start > range.end.
NowAfterEnd if now > range.end where now is the current timestamp.
NoRecordDate if CA has no record date.
RecordDateAfterStart if date > range.start where date is the CA’s record date.
AlreadyExists if there’s a ballot already.
NumberOfChoicesOverflow if the total choice in meta overflows usize.
TooLong if any of the embedded strings in meta are too long.
InsufficientBalance if the protocol fee couldn’t be charged.

source

pub fn vote(
 &self,
 ca_id: CAId,
 votes: Vec<BallotVote>
) -> Result<WrappedCall<'api>>

Cast votes in the ballot attached to the CA identified by ca_id.

Arguments

origin which must be a permissioned signer targeted by the CA.
ca_id identifies the attached ballot’s CA.
votes specifies the balances to assign to each choice in the ballot. The full voting power of origin’s DID may be used for each motion in the ballot.

Errors

NoSuchBallot if ca_id does not identify a ballot.
VotingNotStarted if the voting period hasn’t commenced yet.
VotingAlreadyEnded if the voting period has ended.
WrongVoteCount if the number of choices in the ballot does not match votes.len().
NoSuchCA if ca_id does not identify an existing CA.
NotTargetedByCA if the CA does not target origin’s DID.
InsufficientVotes if the voting power used for any motion in votes exceeds origin’s DID’s voting power.

source

pub fn change_end(&self, ca_id: CAId, end: u64) -> Result<WrappedCall<'api>>

Amend the end date of the ballot of the CA identified by ca_id.

Arguments

origin is a signer that has permissions to act as an agent of ca_id.ticker.
ca_id identifies the attached ballot’s CA.
end specifies the new end date of the ballot.

Errors

UnauthorizedAgent if origin is not agent-permissioned for ticker.
NoSuchBallot if ca_id does not identify a ballot.
VotingAlreadyStarted if start >= now, where now is the current time.
StartAfterEnd if start > end.

source

pub fn change_meta(
 &self,
 ca_id: CAId,
 meta: BallotMeta
) -> Result<WrappedCall<'api>>

Amend the metadata (title, motions, etc.) of the ballot of the CA identified by ca_id.

Arguments

origin is a signer that has permissions to act as an agent of ca_id.ticker.
ca_id identifies the attached ballot’s CA.
meta specifies the new metadata.

Errors

UnauthorizedAgent if origin is not agent-permissioned for ticker.
NoSuchBallot if ca_id does not identify a ballot.
VotingAlreadyStarted if start >= now, where now is the current time.
NumberOfChoicesOverflow if the total choice in meta overflows usize.
TooLong if any of the embedded strings in meta are too long.

source

pub fn change_rcv(&self, ca_id: CAId, rcv: bool) -> Result<WrappedCall<'api>>

Amend RCV support for the ballot of the CA identified by ca_id.

Arguments

origin is a signer that has permissions to act as an agent of ca_id.ticker.
ca_id identifies the attached ballot’s CA.
rcv specifies if RCV is to be supported or not.

Errors

UnauthorizedAgent if origin is not agent-permissioned for ticker.
NoSuchBallot if ca_id does not identify a ballot.
VotingAlreadyStarted if start >= now, where now is the current time.

source

pub fn remove_ballot(&self, ca_id: CAId) -> Result<WrappedCall<'api>>

Remove the ballot of the CA identified by ca_id.

Arguments

origin is a signer that has permissions to act as an agent of ca_id.ticker.
ca_id identifies the attached ballot’s CA.

Errors

UnauthorizedAgent if origin is not agent-permissioned for ticker.
NoSuchBallot if ca_id does not identify a ballot.
VotingAlreadyStarted if start >= now, where now is the current time.

Trait Implementations

source

impl<'api> Clone for CallApi<'api>

source

fn clone(&self) -> CallApi<'api>

Returns a copy of the value. Read more

1.0.0 · source

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl<'api> From<&'api Api> for CallApi<'api>

source

fn from(api: &'api Api) -> Self

Converts to this type from the input type.

Auto Trait Implementations

impl<'api> !RefUnwindSafe for CallApi<'api>

impl<'api> Send for CallApi<'api>

impl<'api> Sync for CallApi<'api>

impl<'api> Unpin for CallApi<'api>

impl<'api> !UnwindSafe for CallApi<'api>

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Downcast for Twhere
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>`impl<W> Write for Box<W, Global>where W: Write + ?Sized,impl<R> Read for Box<R, Global>where R: Read + ?Sized,impl<I, A> Iterator for Box<I, A>where I: Iterator + ?Sized, A: Allocator, type Item = ::Item;impl<F, A> Future for Box<F, A>where F: Future + Unpin + ?Sized, A: Allocator + 'static, type Output = <F as Future>::Output;`

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source