Google Chat V1 API - Class Google::Apps::Chat::V1::ListSpacesRequest (v0.2.0)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::ListSpacesRequest.

A request to list the spaces the caller is a member of.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Optional. A query filter.

    You can filter spaces by the space type (space_type).

    To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

    For example, the following queries are valid:

    space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Optional. A query filter.

    You can filter spaces by the space type (space_type).

    To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

    For example, the following queries are valid:

    space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

Returns
  • (::String) — Optional. A query filter.

    You can filter spaces by the space type (space_type).

    To filter by space type, you must specify valid enum value, such as SPACE or GROUP_CHAT (the space_type can't be SPACE_TYPE_UNSPECIFIED). To query for multiple space types, use the OR operator.

    For example, the following queries are valid:

    space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of spaces to return. The service might return fewer than this value.

    If unspecified, at most 100 spaces 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of spaces to return. The service might return fewer than this value.

    If unspecified, at most 100 spaces 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.

Returns
  • (::Integer) — Optional. The maximum number of spaces to return. The service might return fewer than this value.

    If unspecified, at most 100 spaces 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

def page_token() -> ::String
Returns
  • (::String) — Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

    When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

    When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.

Returns
  • (::String) — Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page.

    When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.