Trait polkadot_sdk_frame::traits::schedule::v1::Anon
pub trait Anon<BlockNumber, Call, RuntimeOrigin> {
type Address: Codec + Clone + Eq + EncodeLike + Debug + TypeInfo + MaxEncodedLen;
// Required methods
fn schedule(
when: DispatchTime<BlockNumber>,
maybe_periodic: Option<(BlockNumber, u32)>,
priority: u8,
origin: RuntimeOrigin,
call: Call,
) -> Result<Self::Address, DispatchError>;
fn cancel(address: Self::Address) -> Result<(), ()>;
fn reschedule(
address: Self::Address,
when: DispatchTime<BlockNumber>,
) -> Result<Self::Address, DispatchError>;
fn next_dispatch_time(address: Self::Address) -> Result<BlockNumber, ()>;
}
v3
instead. Will be removed after September 2024.Expand description
A type that can be used as a scheduler.
Required Associated Typesยง
Required Methodsยง
fn schedule(
when: DispatchTime<BlockNumber>,
maybe_periodic: Option<(BlockNumber, u32)>,
priority: u8,
origin: RuntimeOrigin,
call: Call,
) -> Result<Self::Address, DispatchError>
๐Deprecated: Use v3
instead. Will be removed after September 2024.
fn schedule( when: DispatchTime<BlockNumber>, maybe_periodic: Option<(BlockNumber, u32)>, priority: u8, origin: RuntimeOrigin, call: Call, ) -> Result<Self::Address, DispatchError>
v3
instead. Will be removed after September 2024.Schedule a dispatch to happen at the beginning of some block in the future.
This is not named.
fn cancel(address: Self::Address) -> Result<(), ()>
๐Deprecated: Use v3
instead. Will be removed after September 2024.
fn cancel(address: Self::Address) -> Result<(), ()>
v3
instead. Will be removed after September 2024.Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also.
Will return an error if the address
is invalid.
NOTE: This guaranteed to work only before the point that it is due to be executed. If it ends up being delayed beyond the point of execution, then it cannot be cancelled.
NOTE2: This will not work to cancel periodic tasks after their initial execution. For
that, you must name the task explicitly using the Named
trait.
fn reschedule(
address: Self::Address,
when: DispatchTime<BlockNumber>,
) -> Result<Self::Address, DispatchError>
๐Deprecated: Use v3
instead. Will be removed after September 2024.
fn reschedule( address: Self::Address, when: DispatchTime<BlockNumber>, ) -> Result<Self::Address, DispatchError>
v3
instead. Will be removed after September 2024.Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed
only if it is executed before the currently scheduled block. For periodic tasks,
this dispatch is guaranteed to succeed only before the initial execution; for
others, use reschedule_named
.
Will return an error if the address
is invalid.
fn next_dispatch_time(address: Self::Address) -> Result<BlockNumber, ()>
๐Deprecated: Use v3
instead. Will be removed after September 2024.
fn next_dispatch_time(address: Self::Address) -> Result<BlockNumber, ()>
v3
instead. Will be removed after September 2024.Return the next dispatch time for a given task.
Will return an error if the address
is invalid.