Google Chat V1 API - Class Google::Apps::Chat::V1::FindGroupChatsRequest (v0.24.0)

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

A request to get group chat spaces based on user resources.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#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 10 spaces are returned.

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

    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 10 spaces are returned.

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

    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 10 spaces are returned.

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

    Negative values return an INVALID_ARGUMENT error.

#page_token

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

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

#page_token=

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

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

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

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

#space_view

def space_view() -> ::Google::Apps::Chat::V1::SpaceView
Returns
  • (::Google::Apps::Chat::V1::SpaceView) — Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.

#space_view=

def space_view=(value) -> ::Google::Apps::Chat::V1::SpaceView
Parameter
  • value (::Google::Apps::Chat::V1::SpaceView) — Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.
Returns
  • (::Google::Apps::Chat::V1::SpaceView) — Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.

#users

def users() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

    The maximum number of users that can be specified in a single request is 49.

    Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

#users=

def users=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

    The maximum number of users that can be specified in a single request is 49.

    Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

Returns
  • (::Array<::String>) — Optional. Resource names of all human users in group chat with the calling user. Chat apps can't be included in the request.

    The maximum number of users that can be specified in a single request is 49.

    Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.