Skip to main content

Action

Enum Action 

Source
pub enum Action {
    Button {
        identifier: String,
        title: String,
        requires_authentication: bool,
    },
    Reply {
        identifier: String,
        title: String,
        button_title: String,
        placeholder: String,
        requires_authentication: bool,
    },
}
Expand description

A notification action.

Use Action::button for a plain button or Action::reply for a text-input action. Chain Action::requires_authentication on either to require Touch ID / password before the action fires.

Variants§

§

Button

A plain button action.

Fields

§identifier: String

Identifier sent back in NotificationResponse::action_identifier.

§title: String

Button label shown to the user.

§requires_authentication: bool

Require Touch ID / password before firing.

§

Reply

A text-input action.

The user’s input is delivered via NotificationResponse::reply_text.

macOS only renders one Reply action correctly per notification. If multiple are added, only the first is used.

Fields

§identifier: String

Identifier sent back in NotificationResponse::action_identifier.

§title: String

Label shown in the Options menu.

§button_title: String

Label on the submit button inside the expanded text field.

§placeholder: String

Placeholder text inside the input field.

§requires_authentication: bool

Require Touch ID / password before opening the text field.

Implementations§

Source§

impl Action

Source

pub fn button(identifier: impl Into<String>, title: impl Into<String>) -> Self

Create a plain button action.

Source

pub fn reply( identifier: impl Into<String>, title: impl Into<String>, button_title: impl Into<String>, placeholder: impl Into<String>, ) -> Self

Create a text-input (reply) action.

  • button_title is the label on the submit button (e.g. "Send").
  • placeholder is the hint text inside the empty input field.
Source

pub fn requires_authentication(self) -> Self

Require Touch ID / password before the action fires.

Works for both Action::Button and Action::Reply.

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Action

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Action

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.