target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Users.Spaces.UpdateSpaceReadState.html Maven / Gradle / Ivy
HangoutsChat.Users.Spaces.UpdateSpaceReadState (Google Chat API v1-rev20240829-2.0.0)
com.google.api.services.chat.v1
Class HangoutsChat.Users.Spaces.UpdateSpaceReadState
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.chat.v1.HangoutsChatRequest<SpaceReadState>
-
- com.google.api.services.chat.v1.HangoutsChat.Users.Spaces.UpdateSpaceReadState
-
- Enclosing class:
- HangoutsChat.Users.Spaces
public class HangoutsChat.Users.Spaces.UpdateSpaceReadState
extends HangoutsChatRequest<SpaceReadState>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected UpdateSpaceReadState(String name,
SpaceReadState content)
Updates a user's read state within a space, used to identify read and unread messages.
-
Method Summary
-
Methods inherited from class com.google.api.services.chat.v1.HangoutsChatRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
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
-
UpdateSpaceReadState
protected UpdateSpaceReadState(String name,
SpaceReadState content)
Updates a user's read state within a space, used to identify read and unread messages. For an
example, see [Update a user's space read
state](https://developers.google.com/workspace/chat/update-space-read-state). Requires [user
authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
Create a request for the method "spaces.updateSpaceReadState".
This request holds the parameters needed by the the chat server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation. UpdateSpaceReadState#initialize(com.google.api.client.googleapis.services
.AbstractGoogleClientRequest) must be called to initialize this instance immediately after
invoking the constructor.
- Parameters:
name - Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`content - the SpaceReadState- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public HangoutsChat.Users.Spaces.UpdateSpaceReadState set$Xgafv(String $Xgafv)
Description copied from class: HangoutsChatRequest
V1 error format.
- Overrides:
set$Xgafv in class HangoutsChatRequest<SpaceReadState>
-
setAccessToken
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setAccessToken(String accessToken)
Description copied from class: HangoutsChatRequest
OAuth access token.
- Overrides:
setAccessToken in class HangoutsChatRequest<SpaceReadState>
-
setAlt
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setAlt(String alt)
Description copied from class: HangoutsChatRequest
Data format for response.
- Overrides:
setAlt in class HangoutsChatRequest<SpaceReadState>
-
setCallback
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setCallback(String callback)
Description copied from class: HangoutsChatRequest
JSONP
- Overrides:
setCallback in class HangoutsChatRequest<SpaceReadState>
-
setFields
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setFields(String fields)
Description copied from class: HangoutsChatRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class HangoutsChatRequest<SpaceReadState>
-
setKey
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setKey(String key)
Description copied from class: HangoutsChatRequest
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
- Overrides:
setKey in class HangoutsChatRequest<SpaceReadState>
-
setOauthToken
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setOauthToken(String oauthToken)
Description copied from class: HangoutsChatRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class HangoutsChatRequest<SpaceReadState>
-
setPrettyPrint
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setPrettyPrint(Boolean prettyPrint)
Description copied from class: HangoutsChatRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class HangoutsChatRequest<SpaceReadState>
-
setQuotaUser
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setQuotaUser(String quotaUser)
Description copied from class: HangoutsChatRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
assigned to a user, but should not exceed 40 characters.
- Overrides:
setQuotaUser in class HangoutsChatRequest<SpaceReadState>
-
setUploadType
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setUploadType(String uploadType)
Description copied from class: HangoutsChatRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class HangoutsChatRequest<SpaceReadState>
-
setUploadProtocol
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setUploadProtocol(String uploadProtocol)
Description copied from class: HangoutsChatRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class HangoutsChatRequest<SpaceReadState>
-
getName
public String getName()
Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`
-
setName
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setName(String name)
Resource name of the space read state. Format:
`users/{user}/spaces/{space}/spaceReadState`
-
getUpdateMask
public String getUpdateMask()
Required. The field paths to update. Currently supported field paths: - `last_read_time` When the
`last_read_time` is before the latest message create time, the space appears as unread in the UI.
To mark the space as read, set `last_read_time` to any value later (larger) than the latest message
create time. The `last_read_time` is coerced to match the latest message create time. Note that the
space read state only affects the read state of messages that are visible in the space's top-level
conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread
read state.
-
setUpdateMask
public HangoutsChat.Users.Spaces.UpdateSpaceReadState setUpdateMask(String updateMask)
Required. The field paths to update. Currently supported field paths: - `last_read_time`
When the `last_read_time` is before the latest message create time, the space appears as
unread in the UI. To mark the space as read, set `last_read_time` to any value later
(larger) than the latest message create time. The `last_read_time` is coerced to match
the latest message create time. Note that the space read state only affects the read
state of messages that are visible in the space's top-level conversation. Replies in
threads are unaffected by this timestamp, and instead rely on the thread read state.
-
set
public HangoutsChat.Users.Spaces.UpdateSpaceReadState set(String parameterName,
Object value)
- Overrides:
set in class HangoutsChatRequest<SpaceReadState>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy