#[non_exhaustive]pub struct PushAdmMessageTemplateContentBuilder { /* private fields */ }Expand description
A builder for PushAdmMessageTemplateContent.
Implementations§
Source§impl PushAdmMessageTemplateContentBuilder
impl PushAdmMessageTemplateContentBuilder
Sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
The title to use in a push notification that's based on the message template. This title appears 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 title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Sourcepub fn get_title(&self) -> &Option<String>
pub fn get_title(&self) -> &Option<String>
The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
Sourcepub fn body(self, input: MessageTemplateBodyContentProvider) -> Self
pub fn body(self, input: MessageTemplateBodyContentProvider) -> Self
The message body to use in a push notification that is based on the message template.
Sourcepub fn set_body(self, input: Option<MessageTemplateBodyContentProvider>) -> Self
pub fn set_body(self, input: Option<MessageTemplateBodyContentProvider>) -> Self
The message body to use in a push notification that is based on the message template.
Sourcepub fn get_body(&self) -> &Option<MessageTemplateBodyContentProvider>
pub fn get_body(&self) -> &Option<MessageTemplateBodyContentProvider>
The message body to use in a push notification that is based on the message template.
Sourcepub fn action(self, input: PushMessageAction) -> Self
pub fn action(self, input: PushMessageAction) -> Self
The action to occur if a recipient taps a push notification that is based on the message template. 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 action uses the deep-linking features of the Android platform. -
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<PushMessageAction>) -> Self
pub fn set_action(self, input: Option<PushMessageAction>) -> Self
The action to occur if a recipient taps a push notification that is based on the message template. 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 action uses the deep-linking features of the Android platform. -
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<PushMessageAction>
pub fn get_action(&self) -> &Option<PushMessageAction>
The action to occur if a recipient taps a push notification that is based on the message template. 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 action uses the deep-linking features of the Android platform. -
URL- The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
Sourcepub fn sound(self, input: impl Into<String>) -> Self
pub fn sound(self, input: impl Into<String>) -> Self
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Sourcepub fn set_sound(self, input: Option<String>) -> Self
pub fn set_sound(self, input: Option<String>) -> Self
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Sourcepub fn get_sound(&self) -> &Option<String>
pub fn get_sound(&self) -> &Option<String>
The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
Sourcepub fn url(self, input: impl Into<String>) -> Self
pub fn url(self, input: impl Into<String>) -> Self
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template 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 URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.
Sourcepub fn get_url(&self) -> &Option<String>
pub fn get_url(&self) -> &Option<String>
The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the action property is URL.
Sourcepub fn image_url(self, input: impl Into<String>) -> Self
pub fn image_url(self, input: impl Into<String>) -> Self
The URL of an image to display in a push notification that's based on the message template.
Sourcepub fn set_image_url(self, input: Option<String>) -> Self
pub fn set_image_url(self, input: Option<String>) -> Self
The URL of an image to display in a push notification that's based on the message template.
Sourcepub fn get_image_url(&self) -> &Option<String>
pub fn get_image_url(&self) -> &Option<String>
The URL of an image to display in a push notification that's based on the message template.
Sourcepub fn image_icon_url(self, input: impl Into<String>) -> Self
pub fn image_icon_url(self, input: impl Into<String>) -> Self
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
Sourcepub fn set_image_icon_url(self, input: Option<String>) -> Self
pub fn set_image_icon_url(self, input: Option<String>) -> Self
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
Sourcepub fn get_image_icon_url(&self) -> &Option<String>
pub fn get_image_icon_url(&self) -> &Option<String>
The URL of the large icon image to display in the content view of a push notification that's based on the message template.
Sourcepub fn small_image_icon_url(self, input: impl Into<String>) -> Self
pub fn small_image_icon_url(self, input: impl Into<String>) -> Self
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sourcepub fn set_small_image_icon_url(self, input: Option<String>) -> Self
pub fn set_small_image_icon_url(self, input: Option<String>) -> Self
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sourcepub fn get_small_image_icon_url(&self) -> &Option<String>
pub fn get_small_image_icon_url(&self) -> &Option<String>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sourcepub fn raw_content(self, input: MessageTemplateBodyContentProvider) -> Self
pub fn raw_content(self, input: MessageTemplateBodyContentProvider) -> Self
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sourcepub fn set_raw_content(
self,
input: Option<MessageTemplateBodyContentProvider>,
) -> Self
pub fn set_raw_content( self, input: Option<MessageTemplateBodyContentProvider>, ) -> Self
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sourcepub fn get_raw_content(&self) -> &Option<MessageTemplateBodyContentProvider>
pub fn get_raw_content(&self) -> &Option<MessageTemplateBodyContentProvider>
The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
Sourcepub fn build(self) -> PushAdmMessageTemplateContent
pub fn build(self) -> PushAdmMessageTemplateContent
Consumes the builder and constructs a PushAdmMessageTemplateContent.
Trait Implementations§
Source§impl Clone for PushAdmMessageTemplateContentBuilder
impl Clone for PushAdmMessageTemplateContentBuilder
Source§fn clone(&self) -> PushAdmMessageTemplateContentBuilder
fn clone(&self) -> PushAdmMessageTemplateContentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for PushAdmMessageTemplateContentBuilder
impl Default for PushAdmMessageTemplateContentBuilder
Source§fn default() -> PushAdmMessageTemplateContentBuilder
fn default() -> PushAdmMessageTemplateContentBuilder
Source§impl PartialEq for PushAdmMessageTemplateContentBuilder
impl PartialEq for PushAdmMessageTemplateContentBuilder
Source§fn eq(&self, other: &PushAdmMessageTemplateContentBuilder) -> bool
fn eq(&self, other: &PushAdmMessageTemplateContentBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for PushAdmMessageTemplateContentBuilder
Auto Trait Implementations§
impl Freeze for PushAdmMessageTemplateContentBuilder
impl RefUnwindSafe for PushAdmMessageTemplateContentBuilder
impl Send for PushAdmMessageTemplateContentBuilder
impl Sync for PushAdmMessageTemplateContentBuilder
impl Unpin for PushAdmMessageTemplateContentBuilder
impl UnwindSafe for PushAdmMessageTemplateContentBuilder
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
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>
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);