Struct MessageComponents

#[non_exhaustive]
pub struct MessageComponents {
    pub headline: Option<String>,
    pub paragraph_summary: Option<String>,
    pub complete_description: Option<String>,
    pub dimensions: Option<Vec<Dimension>>,
}

Describes the components of a notification message.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

headline: Option<String>

A sentence long summary. For example, titles or an email subject line.

paragraph_summary: Option<String>

A paragraph long or multiple sentence summary. For example, Chatbot notifications.

complete_description: Option<String>

A complete summary with all possible relevant information.

dimensions: Option<Vec<Dimension>>

A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

Included dimensions, keys, and values are subject to change.

Implementations

impl MessageComponents

pub fn headline(&self) -> Option<&str>

A sentence long summary. For example, titles or an email subject line.

pub fn paragraph_summary(&self) -> Option<&str>

A paragraph long or multiple sentence summary. For example, Chatbot notifications.

pub fn complete_description(&self) -> Option<&str>

A complete summary with all possible relevant information.

pub fn dimensions(&self) -> &[Dimension]

A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

Included dimensions, keys, and values are subject to change.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .dimensions.is_none().

impl MessageComponents

pub fn builder() -> MessageComponentsBuilder

Creates a new builder-style object to manufacture MessageComponents.

Trait Implementations

impl Clone for MessageComponents

fn clone(&self) -> MessageComponents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageComponents

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

Formats the value using the given formatter.

impl PartialEq for MessageComponents

fn eq(&self, other: &MessageComponents) -> 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 StructuralPartialEq for MessageComponents