com.google.api.services.chat.v1.model

Class SearchMessageResult

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.chat.v1.model.SearchMessageResult

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SearchMessageResult
extends com.google.api.client.json.GenericJson

A single result item from a message search.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Chat API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SearchMessageResult()

Method Summary

Modifier and Type	Method and Description
SearchMessageResult	clone()
Message	getMessage() The matched message.
Boolean	getRead() Indicates if the matched message is read by the calling user.
String	getSpaceMuteSetting() The mute setting of the calling user for the space where the message is posted.
SearchMessageResult	set(String fieldName, Object value)
SearchMessageResult	setMessage(Message message) The matched message.
SearchMessageResult	setRead(Boolean read) Indicates if the matched message is read by the calling user.
SearchMessageResult	setSpaceMuteSetting(String spaceMuteSetting) The mute setting of the calling user for the space where the message is posted.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SearchMessageResult

public SearchMessageResult()

Method Detail

getMessage

public Message getMessage()

The matched message.

Returns:

value or null for none

setMessage

public SearchMessageResult setMessage(Message message)

The matched message.

Parameters:

message - message or null for none

getRead

public Boolean getRead()

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://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`

Returns:

value or null for none

setRead

public SearchMessageResult setRead(Boolean read)

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://developers.google.com/workspace/chat/authenticate- authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`

Parameters:

read - read or null for none

getSpaceMuteSetting

public String getSpaceMuteSetting()

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://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`

Returns:

value or null for none

setSpaceMuteSetting

public SearchMessageResult setSpaceMuteSetting(String spaceMuteSetting)

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://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.spacesettings`

Parameters:

spaceMuteSetting - spaceMuteSetting or null for none

set

public SearchMessageResult set(String fieldName,
                               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SearchMessageResult clone()

Overrides:

clone in class com.google.api.client.json.GenericJson