#[non_exhaustive]pub struct DefaultPushNotificationMessageBuilder { /* private fields */ }Expand description
A builder for DefaultPushNotificationMessage.
Implementations§
Source§impl DefaultPushNotificationMessageBuilder
impl DefaultPushNotificationMessageBuilder
Sourcepub fn action(self, input: Action) -> Self
pub fn action(self, input: Action) -> Self
The default action to occur if a recipient taps the push notification. Valid values are:
-
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
-
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
-
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Sourcepub fn set_action(self, input: Option<Action>) -> Self
pub fn set_action(self, input: Option<Action>) -> Self
The default action to occur if a recipient taps the push notification. Valid values are:
-
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
-
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
-
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Sourcepub fn get_action(&self) -> &Option<Action>
pub fn get_action(&self) -> &Option<Action>
The default action to occur if a recipient taps the push notification. Valid values are:
-
OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
-
DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
-
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Sourcepub fn body(self, input: impl Into<String>) -> Self
pub fn body(self, input: impl Into<String>) -> Self
The default body of the notification message.
Sourcepub fn set_body(self, input: Option<String>) -> Self
pub fn set_body(self, input: Option<String>) -> Self
The default body of the notification message.
Sourcepub fn data(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn data(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to data.
To override the contents of this collection use set_data.
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Sourcepub fn set_data(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_data(self, input: Option<HashMap<String, String>>) -> Self
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Sourcepub fn get_data(&self) -> &Option<HashMap<String, String>>
pub fn get_data(&self) -> &Option<HashMap<String, String>>
The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
Sourcepub fn silent_push(self, input: bool) -> Self
pub fn silent_push(self, input: bool) -> Self
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
Sourcepub fn set_silent_push(self, input: Option<bool>) -> Self
pub fn set_silent_push(self, input: Option<bool>) -> Self
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
Sourcepub fn get_silent_push(&self) -> &Option<bool>
pub fn get_silent_push(&self) -> &Option<bool>
Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
Sourcepub fn substitutions(self, k: impl Into<String>, v: Vec<String>) -> Self
pub fn substitutions(self, k: impl Into<String>, v: Vec<String>) -> Self
Adds a key-value pair to substitutions.
To override the contents of this collection use set_substitutions.
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Sourcepub fn set_substitutions(
self,
input: Option<HashMap<String, Vec<String>>>,
) -> Self
pub fn set_substitutions( self, input: Option<HashMap<String, Vec<String>>>, ) -> Self
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Sourcepub fn get_substitutions(&self) -> &Option<HashMap<String, Vec<String>>>
pub fn get_substitutions(&self) -> &Option<HashMap<String, Vec<String>>>
The default message variables to use in the notification message. You can override the default variables with individual address variables.
Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
The default title to display above the notification message on a recipient's device.
Sourcepub fn set_title(self, input: Option<String>) -> Self
pub fn set_title(self, input: Option<String>) -> Self
The default title to display above the notification message on a recipient's device.
Sourcepub fn get_title(&self) -> &Option<String>
pub fn get_title(&self) -> &Option<String>
The default title to display above the notification message on a recipient's device.
Sourcepub fn url(self, input: impl Into<String>) -> Self
pub fn url(self, input: impl Into<String>) -> Self
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
Sourcepub fn set_url(self, input: Option<String>) -> Self
pub fn set_url(self, input: Option<String>) -> Self
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
Sourcepub fn get_url(&self) -> &Option<String>
pub fn get_url(&self) -> &Option<String>
The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
Sourcepub fn build(self) -> DefaultPushNotificationMessage
pub fn build(self) -> DefaultPushNotificationMessage
Consumes the builder and constructs a DefaultPushNotificationMessage.
Trait Implementations§
Source§impl Clone for DefaultPushNotificationMessageBuilder
impl Clone for DefaultPushNotificationMessageBuilder
Source§fn clone(&self) -> DefaultPushNotificationMessageBuilder
fn clone(&self) -> DefaultPushNotificationMessageBuilder
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for DefaultPushNotificationMessageBuilder
impl Default for DefaultPushNotificationMessageBuilder
Source§fn default() -> DefaultPushNotificationMessageBuilder
fn default() -> DefaultPushNotificationMessageBuilder
Source§impl PartialEq for DefaultPushNotificationMessageBuilder
impl PartialEq for DefaultPushNotificationMessageBuilder
Source§fn eq(&self, other: &DefaultPushNotificationMessageBuilder) -> bool
fn eq(&self, other: &DefaultPushNotificationMessageBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for DefaultPushNotificationMessageBuilder
Auto Trait Implementations§
impl Freeze for DefaultPushNotificationMessageBuilder
impl RefUnwindSafe for DefaultPushNotificationMessageBuilder
impl Send for DefaultPushNotificationMessageBuilder
impl Sync for DefaultPushNotificationMessageBuilder
impl Unpin for DefaultPushNotificationMessageBuilder
impl UnsafeUnpin for DefaultPushNotificationMessageBuilder
impl UnwindSafe for DefaultPushNotificationMessageBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);