Struct ListMessagesOptions

pub struct ListMessagesOptions {
    pub action: Option<MessageActionOption>,
    pub direction: Option<MessageDirectionOption>,
    pub from_devices: Option<Vec<DeviceId>>,
    pub to_devices: Option<Vec<DeviceId>>,
    pub read_state: Option<MessageReadStateOption>,
    pub start_date: Option<UtcDateTime>,
    pub end_date: Option<UtcDateTime>,
    pub limit: Option<u16>,
    pub skip: Option<usize>,
}

Options for filtering messages.

Fields

action: Option<MessageActionOption>

Message action.

direction: Option<MessageDirectionOption>

Message direction.

from_devices: Option<Vec<DeviceId>>

Devices that sent the message.

Note: it only applies to inbound sent messages.

to_devices: Option<Vec<DeviceId>>

Devices to which the message was sent.

Note: it only applies to outbound sent messages.

read_state: Option<MessageReadStateOption>

Message read state.

start_date: Option<UtcDateTime>

Start of time period within which message was:

• logged, for logged messages.
• sent, for outbound sent messages.
• received, for inbound sent messages.

end_date: Option<UtcDateTime>

End of time period within which message was:

• logged, for logged messages.
• sent, for outbound sent messages.
• received, for inbound sent messages.

limit: Option<u16>

Maximum number of messages that should be returned.

Note: must be a positive integer value not greater than 500.

skip: Option<usize>

Number of messages that should be skipped.

Note: must be a non-negative (includes zero) integer value.

Trait Implementations

impl Clone for ListMessagesOptions

fn clone(&self) -> ListMessagesOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListMessagesOptions

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

Formats the value using the given formatter.

impl PartialEq for ListMessagesOptions

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

impl StructuralPartialEq for ListMessagesOptions