Class ListMessagesRequest

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

Inheritance

object

ListMessagesRequest

Implements

IPageRequest

IMessage<ListMessagesRequest>

IEquatable<ListMessagesRequest>

IDeepCloneable<ListMessagesRequest>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Apps.Chat.V1

Assembly: Google.Apps.Chat.V1.dll

Syntax

public sealed class ListMessagesRequest : IPageRequest, IMessage<ListMessagesRequest>, IEquatable<ListMessagesRequest>, IDeepCloneable<ListMessagesRequest>, IBufferMessage, IMessage

Constructors

ListMessagesRequest()

Declaration

public ListMessagesRequest()

ListMessagesRequest(ListMessagesRequest)

Declaration

public ListMessagesRequest(ListMessagesRequest other)

Parameters

Type	Name	Description
ListMessagesRequest	other

Properties

Filter

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.

Declaration

public string Filter { get; set; }

Property Value

Type	Description
string

OrderBy

Optional, if resuming from a previous query.

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.

Declaration

public string OrderBy { get; set; }

Property Value

Type	Description
string

PageSize

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.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
int

Implements

IPageRequest.PageSize

PageToken

Optional, if resuming from a previous query.

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.

Declaration

public string PageToken { get; set; }

Property Value

Type	Description
string

Implements

IPageRequest.PageToken

Parent

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

Format: spaces/{space}

Declaration

public string Parent { get; set; }

Property Value

Type	Description
string

ParentAsSpaceName

SpaceName-typed view over the Parent resource name property.

Declaration

public SpaceName ParentAsSpaceName { get; set; }

Property Value

Type	Description
SpaceName

ShowDeleted

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

Declaration

public bool ShowDeleted { get; set; }

Property Value

Type	Description
bool