Struct winrt_toast::Toast

pub struct Toast { /* private fields */ }

Represents a Windows toast.

See https://docs.microsoft.com/en-us/uwp/api/windows.ui.notifications.toastnotification

Implementations

impl Toast

pub fn new() -> Self

Creates an empty toast.

pub fn header(&mut self, header: Header) -> &mut Toast

Add a Header to this toast.

pub fn text1<T: Into<Text>>(&mut self, text: T) -> &mut Toast

The first text element, usually the title.

Example

// You can use anything that is Into<String>
toast.text1("text");

// Or you can use a `Text`
toast.text1(
    Text::new("text").with_placement(TextPlacement::Attribution)
);

pub fn text2<T: Into<Text>>(&mut self, text: T) -> &mut Toast

The second text element, usually the body.

pub fn text3<T: Into<Text>>(&mut self, text: T) -> &mut Toast

The third text element, usually the body or attribution.

pub fn image(&mut self, id: u8, image: Image) -> &mut Toast

Add an image with the corresponding ID to the toast.

ID

The image element in the toast template that this image is intended for. If a template has only one image, then this value is 1. The number of available image positions is based on the template definition.

pub fn action(&mut self, action: Action) -> &mut Toast

Add a new action to the toast.

pub fn tag(&mut self, tag: impl Into<String>) -> &mut Toast

Set the tag of this toast.

See https://docs.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/send-local-toast-cpp-uwp?tabs=xml#provide-a-primary-key-for-your-toast

pub fn group(&mut self, group: impl Into<String>) -> &mut Toast

Set the group of this toast.

See https://docs.microsoft.com/en-us/windows/apps/design/shell/tiles-and-notifications/send-local-toast-cpp-uwp?tabs=xml#provide-a-primary-key-for-your-toast

pub fn remote_id(&mut self, remote_id: impl Into<String>) -> &mut Toast

Set a remote id for the notification that enables the system to correlate this notification with another one generated on another device.

pub fn scenario(&mut self, scenario: Scenario) -> &mut Toast

Set the scenario of this toast.

The scenario adjusts a few behaviors to create a consistent and unified user experience.

pub fn launch(&mut self, launch: impl Into<String>) -> &mut Toast

A string that is passed to the application when it is activated by the toast.

The format and contents of this string are defined by the app for its own use. When the user taps or clicks the toast to launch its associated app, the launch string provides the context to the app that allows it to show the user a view relevant to the toast content, rather than launching in its default way.

pub fn duration(&mut self, duration: ToastDuration) -> &mut Toast

The amount of time the toast should display.

pub fn expires_in(&mut self, duration: Duration) -> &mut Toast

Set the expiration time of this toats, starting from the moment it is shown.

After expiration, the toast will be removed from the Notification Center.

Trait Implementations

impl Clone for Toast

fn clone(&self) -> Toast

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Toast

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

Formats the value using the given formatter.

impl Default for Toast

fn default() -> Toast

Returns the “default value” for a type.