Struct ListMessagesRequest 

#[non_exhaustive]
pub struct ListMessagesRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
    pub order_by: String,
    pub show_deleted: bool,
    pub markup_syntax: MarkupSyntax,
    /* private fields */
}

Lists messages in the specified space, that the user is a member of.

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.

parent: String

Required. The resource name of the space to list messages from.

Format: spaces/{space}

page_size: i32

Optional. The maximum number of messages returned. The service might return fewer messages than this value.

If unspecified, at most 25 are returned.

The maximum value is 1000. If you use a value more than 1000, it’s automatically changed to 1000.

Negative values return an INVALID_ARGUMENT error.

page_token: String

Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

filter: String

Optional. A query filter.

You can filter messages by date (create_time) and thread (thread.name).

To filter messages by the date they were created, specify the create_time with a timestamp in RFC-3339 format and double quotation marks. For example, "2023-04-21T11:30:00-04:00". You can use the greater than operator > to list messages that were created after a timestamp, or the less than operator < to list messages that were created before a timestamp. To filter messages within a time interval, use the AND operator between two timestamps.

To filter by thread, specify the thread.name, formatted as spaces/{space}/threads/{thread}. You can only specify one thread.name per query.

To filter by both thread and date, use the AND operator in your query.

For example, the following queries are valid:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Invalid queries are rejected by the server with an INVALID_ARGUMENT error.

order_by: String

Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows:

• ASC for ascending.

• DESC for descending.

The default ordering is create_time ASC.

show_deleted: bool

Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

markup_syntax: MarkupSyntax

Optional. Specifies the desired output syntax for the Chat message formatted_text field.

Implementations

impl ListMessagesRequest

pub fn new() -> Self

Creates a new default instance.

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = ListMessagesRequest::new().set_parent(format!("spaces/{space_id}"));

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListMessagesRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListMessagesRequest::new().set_page_token("example");

pub fn set_filter<T: Into<String>>(self, v: T) -> Self

Sets the value of filter.

Example

let x = ListMessagesRequest::new().set_filter("example");

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

Sets the value of order_by.

Example

let x = ListMessagesRequest::new().set_order_by("example");

pub fn set_show_deleted<T: Into<bool>>(self, v: T) -> Self

Sets the value of show_deleted.

Example

let x = ListMessagesRequest::new().set_show_deleted(true);

pub fn set_markup_syntax<T: Into<MarkupSyntax>>(self, v: T) -> Self

Sets the value of markup_syntax.

Example

use google_chat_v1::model::MarkupSyntax;
let x0 = ListMessagesRequest::new().set_markup_syntax(MarkupSyntax::Chat);
let x1 = ListMessagesRequest::new().set_markup_syntax(MarkupSyntax::Markdown);

Trait Implementations

impl Clone for ListMessagesRequest

fn clone(&self) -> ListMessagesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListMessagesRequest

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

Formats the value using the given formatter.

impl Default for ListMessagesRequest

fn default() -> ListMessagesRequest

Returns the “default value” for a type.

impl Message for ListMessagesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListMessagesRequest

fn eq(&self, other: &ListMessagesRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ListMessagesRequest