Skip to main content

Schedule

tauri_plugin_notification

Enum Schedule

pub enum Schedule {
    At {
        date: OffsetDateTime,
        repeating: bool,
        allow_while_idle: bool,
    },
    Interval {
        interval: ScheduleInterval,
        allow_while_idle: bool,
    },
    Every {
        interval: ScheduleEvery,
        count: u8,
        allow_while_idle: bool,
    },
}

Expand description

Defines when a notification is delivered.

Scheduling is only implemented on mobile; the desktop implementation delivers the notification immediately and ignores the schedule.

Variants§

At

Fires at a specific date and time, which must be in the future.

Fields

§date: OffsetDateTime

The date and time the notification fires at, serialized as an ISO-8601 string.

§repeating: bool

Whether the notification keeps repeating, using the duration between the moment it is scheduled and date as the interval. Defaults to false.

The interval must be at least one minute on iOS.

§allow_while_idle: bool

Whether the notification is allowed to fire while the device is in low-power idle (Doze) mode. Defaults to false.

Only used on Android.

Interval

Fires whenever the current date matches every field set on the given interval.

Fields

§interval: ScheduleInterval

The date fields the current date must match for the notification to fire.

§allow_while_idle: bool

Whether the notification is allowed to fire while the device is in low-power idle (Doze) mode. Defaults to false.

Only used on Android.

Every

Fires repeatedly, once every count times the given interval unit.

Fields

§interval: ScheduleEvery

The unit of the repeating interval.

§count: u8

How many interval units elapse between each notification.

§allow_while_idle: bool

Whether the notification is allowed to fire while the device is in low-power idle (Doze) mode. Defaults to false.

Only used on Android.

Trait Implementations§

impl Debug for Schedule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Schedule

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for Schedule

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for Schedule

impl RefUnwindSafe for Schedule

impl Send for Schedule

impl Sync for Schedule

impl Unpin for Schedule

impl UnsafeUnpin for Schedule

impl UnwindSafe for Schedule

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<'de, D, R> CommandArg<'de, R> for D
where D: Deserialize<'de>, R: Runtime,

fn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>

Derives an instance of Self from the CommandItem. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IpcResponse for T
where T: Serialize,

fn body(self) -> Result<InvokeResponseBody, Error>

Resolve the IPC response body.

impl<T> MaybeSendSync for T

impl<T> ScopeObject for T
where T: Send + Sync + Debug + DeserializeOwned + 'static,

type Error = Error

The error type.

fn deserialize<R>( _app: &AppHandle<R>, raw: Value, ) -> Result<T, <T as ScopeObject>::Error>
where R: Runtime,

Deserialize the raw scope value.

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more