Google Chat V1 API - Class Google::Apps::Chat::V1::SearchMessageResult (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.1 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.1 0.2.0 0.1.2

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

A single result item from a message search.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#message

def message() -> ::Google::Apps::Chat::V1::Message

Returns

• (::Google::Apps::Chat::V1::Message) — The matched message.

#message=

def message=(value) -> ::Google::Apps::Chat::V1::Message

Parameter

• value (::Google::Apps::Chat::V1::Message) — The matched message.

Returns

• (::Google::Apps::Chat::V1::Message) — The matched message.

#read

def read() -> ::Boolean

Returns

• (::Boolean) —

  Indicates if the matched message is read by the calling user.

  Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

#read=

def read=(value) -> ::Boolean

Parameter

• value (::Boolean) —

  Indicates if the matched message is read by the calling user.

  Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

Returns

• (::Boolean) —

  Indicates if the matched message is read by the calling user.

  Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

#space_mute_setting

def space_mute_setting() -> ::Google::Apps::Chat::V1::SpaceNotificationSetting::MuteSetting

Returns

• (::Google::Apps::Chat::V1::SpaceNotificationSetting::MuteSetting) —

  The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

  Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

  • https://www.googleapis.com/auth/chat.users.spacesettings

#space_mute_setting=

def space_mute_setting=(value) -> ::Google::Apps::Chat::V1::SpaceNotificationSetting::MuteSetting

Parameter

• value (::Google::Apps::Chat::V1::SpaceNotificationSetting::MuteSetting) —

  The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

  Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

  • https://www.googleapis.com/auth/chat.users.spacesettings

Returns

• (::Google::Apps::Chat::V1::SpaceNotificationSetting::MuteSetting) —

  The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

  Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

  • https://www.googleapis.com/auth/chat.users.spacesettings