Struct SmsOutgoingMessage 

pub struct SmsOutgoingMessage {
    pub to: String,
    pub content: String,
    pub validity_period: Option<u8>,
    pub flash: Option<bool>,
    pub timeout: Option<u32>,
}

The outgoing SMS message to be sent to a target number.

Fields

to: String

The target phone number, this should be in international format.

content: String

The full message content. This will be split into multiple messages by the server if required. This also supports Unicode emojis etc.

validity_period: Option<u8>

The relative validity period to use for message sending. This determines how long the message should remain waiting while undelivered. By default, this is determined by the server (24 hours).

flash: Option<bool>

Should the SMS message be sent as a Silent class? This makes a popup show on the users device with the message content if they’re logged in.

timeout: Option<u32>

A timeout that should be applied to the entire request. If one is not set, the default timeout is used.

Implementations

impl SmsOutgoingMessage

pub fn simple_message(to: impl Into<String>, content: impl Into<String>) -> Self

Create a new outgoing message with a default validity period and no flash. The default validity period is applied by SMS-API, so usually 24 hours.

pub fn with_flash(self, flash: bool) -> Self

Set the message flash state. This will show a popup if the recipient is logged-in to their phone, otherwise as a normal text message.

pub fn with_validity_period(self, period: u8) -> Self

Set a relative validity period value.

pub fn with_timeout(self, timeout: u32) -> Self

Set a request timeout value.

pub fn get_validity_period(&self) -> u8

Get the message sending validity period, either as set or default. Returns class 0 for a flash message.

Trait Implementations

impl Clone for SmsOutgoingMessage

fn clone(&self) -> SmsOutgoingMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SmsOutgoingMessage

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

Formats the value using the given formatter.

impl Default for SmsOutgoingMessage

fn default() -> SmsOutgoingMessage

Returns the “default value” for a type.

impl From<&SmsOutgoingMessage> for SmsMessage

fn from(outgoing: &SmsOutgoingMessage) -> Self

Converts to this type from the input type.

impl PartialEq for SmsOutgoingMessage

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SmsOutgoingMessage