Struct ToastNotification

pub struct ToastNotification(/* private fields */);

Implementations

impl ToastNotification

pub fn Content(&self) -> Result<XmlDocument, Error>

pub fn SetExpirationTime<P0>(&self, value: P0) -> Result<(), Error>

where P0: Param<IReference<DateTime>>,

pub fn ExpirationTime(&self) -> Result<IReference<DateTime>, Error>

pub fn Dismissed<P0>( &self, handler: P0, ) -> Result<EventRegistrationToken, Error>

where P0: Param<TypedEventHandler<ToastNotification, ToastDismissedEventArgs>>,

pub fn RemoveDismissed( &self, token: EventRegistrationToken, ) -> Result<(), Error>

pub fn Activated<P0>( &self, handler: P0, ) -> Result<EventRegistrationToken, Error>

where P0: Param<TypedEventHandler<ToastNotification, IInspectable>>,

pub fn RemoveActivated( &self, token: EventRegistrationToken, ) -> Result<(), Error>

pub fn Failed<P0>(&self, handler: P0) -> Result<EventRegistrationToken, Error>

where P0: Param<TypedEventHandler<ToastNotification, ToastFailedEventArgs>>,

pub fn RemoveFailed(&self, token: EventRegistrationToken) -> Result<(), Error>

pub fn SetTag(&self, value: &HSTRING) -> Result<(), Error>

pub fn Tag(&self) -> Result<HSTRING, Error>

pub fn SetGroup(&self, value: &HSTRING) -> Result<(), Error>

pub fn Group(&self) -> Result<HSTRING, Error>

pub fn SetSuppressPopup(&self, value: bool) -> Result<(), Error>

pub fn SuppressPopup(&self) -> Result<bool, Error>

pub fn NotificationMirroring(&self) -> Result<NotificationMirroring, Error>

pub fn SetNotificationMirroring( &self, value: NotificationMirroring, ) -> Result<(), Error>

pub fn RemoteId(&self) -> Result<HSTRING, Error>

pub fn SetRemoteId(&self, value: &HSTRING) -> Result<(), Error>

pub fn Data(&self) -> Result<NotificationData, Error>

pub fn SetData<P0>(&self, value: P0) -> Result<(), Error>

where P0: Param<NotificationData>,

pub fn Priority(&self) -> Result<ToastNotificationPriority, Error>

pub fn SetPriority(&self, value: ToastNotificationPriority) -> Result<(), Error>

pub fn ExpiresOnReboot(&self) -> Result<bool, Error>

pub fn SetExpiresOnReboot(&self, value: bool) -> Result<(), Error>

pub fn CreateToastNotification<P0>( content: P0, ) -> Result<ToastNotification, Error>

where P0: Param<XmlDocument>,

Examples found in repository

examples/without_library.rs (line 49)

fn do_toast() -> windows::core::Result<()> {
    let toast_xml = XmlDocument::new()?;

    toast_xml.LoadXml(&HSTRING::from(
        format!(r#"<toast duration="long">
                <visual>
                    <binding template="ToastGeneric">
                        <text id="1">title</text>
                        <text id="2">first line</text>
                        <text id="3">third line</text>
                        <image placement="appLogoOverride" hint-crop="circle" src="file:///c:/path_to_image_above_toast.jpg" alt="alt text" />
                        <image placement="Hero" src="file:///C:/path_to_image_in_toast.jpg" alt="alt text2" />
                        <image id="1" src="file:///{}" alt="another_image" />
                    </binding>
                </visual>
                <audio src="ms-winsoundevent:Notification.SMS" />
                <!-- <audio silent="true" /> -->
            </toast>"#,
            quick_xml::escape::escape(&Path::new("C:\\path_to_image_in_toast.jpg").display().to_string()),
    ))).expect("the xml is malformed");

    // Create the toast and attach event listeners
    let toast_template = ToastNotification::CreateToastNotification(&toast_xml)?;

    // If you have a valid app id, (ie installed using wix) then use it here.
    let toast_notifier = ToastNotificationManager::CreateToastNotifierWithId(&HSTRING::from(
        "{1AC14E77-02E7-4E5D-B744-2EB1AE5198B7}\\WindowsPowerShell\\v1.0\\powershell.exe",
    ))?;

    // Show the toast.
    // Note this returns success in every case, including when the toast isn't shown.
    toast_notifier.Show(&toast_template)
}

Trait Implementations

impl Clone for ToastNotification

fn clone(&self) -> ToastNotification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToastNotification

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

Formats the value using the given formatter.

impl Interface for ToastNotification

const IID: GUID = <IToastNotification as windows_core::Interface>::IID

The GUID associated with the interface.

fn as_raw(&self) -> *mut c_void

Returns the raw COM interface pointer. The resulting pointer continues to be owned by the Interface implementation.

fn into_raw(self) -> *mut c_void

Returns the raw COM interface pointer and releases ownership. It the caller’s responsibility to release the COM interface pointer.

unsafe fn from_raw(raw: *mut c_void) -> Self

Creates an Interface by taking ownership of the raw COM interface pointer.

unsafe fn from_raw_borrowed(raw: &*mut c_void) -> Option<&Self>

Creates an Interface that is valid so long as the raw COM interface pointer is valid.

fn cast<T>(&self) -> Result<T, Error>

where T: Interface,

Attempts to cast the current interface to another interface using QueryInterface.

fn cast_to_any<T>(&self) -> Result<&(dyn Any + 'static), Error>

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

This casts the given COM interface to [&dyn Any].

fn is_object<T>(&self) -> bool

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

Returns true if the given COM interface refers to an implementation of T.

fn cast_object_ref<T>(&self) -> Result<&<T as ComObjectInner>::Outer, Error>

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

This casts the given COM interface to [&dyn Any]. It returns a reference to the “outer” object, e.g. &MyApp_Impl, not the inner &MyApp object.

fn cast_object<T>(&self) -> Result<ComObject<T>, Error>

where T: ComObjectInner, <T as ComObjectInner>::Outer: Any + 'static + IUnknownImpl<Impl = T>,

This casts the given COM interface to [&dyn Any]. It returns a reference to the “outer” object, e.g. MyApp_Impl, not the inner MyApp object.

fn downgrade(&self) -> Result<Weak<Self>, Error>

Attempts to create a Weak reference to this object.

unsafe fn query(&self, iid: *const GUID, interface: *mut *mut c_void) -> HRESULT

Call QueryInterface on this interface

fn to_ref(&self) -> InterfaceRef<'_, Self>

Creates an InterfaceRef for this reference. The InterfaceRef tracks lifetimes statically, and eliminates the need for dynamic reference count adjustments (AddRef/Release).

impl PartialEq for ToastNotification

fn eq(&self, other: &ToastNotification) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ToastNotification

impl Send for ToastNotification

impl StructuralPartialEq for ToastNotification

impl Sync for ToastNotification