target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Users.Spaces.GetSpaceReadState.html Maven / Gradle / Ivy
HangoutsChat.Users.Spaces.GetSpaceReadState (Google Chat API v1-rev20240829-2.0.0)
com.google.api.services.chat.v1
Class HangoutsChat.Users.Spaces.GetSpaceReadState
- 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.GetSpaceReadState
-
- Enclosing class:
- HangoutsChat.Users.Spaces
public class HangoutsChat.Users.Spaces.GetSpaceReadState
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 GetSpaceReadState(String name)
Returns details about 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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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
-
GetSpaceReadState
protected GetSpaceReadState(String name)
Returns details about a user's read state within a space, used to identify read and unread
messages. For an example, see [Get details about a user's space read
state](https://developers.google.com/workspace/chat/get-space-read-state). Requires [user
authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
Create a request for the method "spaces.getSpaceReadState".
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.
GetSpaceReadState#initialize(com.google.api.client.googleapis.services.AbstractGoogl
eClientRequest) must be called to initialize this instance immediately after invoking the
constructor.
- Parameters:
name - Required. Resource name of the space read state to retrieve. Only supports getting read state for
the calling user. To refer to the calling user, set one of the following: - The `me`
alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email
address. For example, `users/[email protected]/spaces/{space}/spaceReadState`. - Their user
id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format:
users/{user}/spaces/{space}/spaceReadState- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SpaceReadState>- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<SpaceReadState>- Throws:
IOException
-
set$Xgafv
public HangoutsChat.Users.Spaces.GetSpaceReadState set$Xgafv(String $Xgafv)
Description copied from class: HangoutsChatRequest
V1 error format.
- Overrides:
set$Xgafv in class HangoutsChatRequest<SpaceReadState>
-
setAccessToken
public HangoutsChat.Users.Spaces.GetSpaceReadState setAccessToken(String accessToken)
Description copied from class: HangoutsChatRequest
OAuth access token.
- Overrides:
setAccessToken in class HangoutsChatRequest<SpaceReadState>
-
setAlt
public HangoutsChat.Users.Spaces.GetSpaceReadState setAlt(String alt)
Description copied from class: HangoutsChatRequest
Data format for response.
- Overrides:
setAlt in class HangoutsChatRequest<SpaceReadState>
-
setCallback
public HangoutsChat.Users.Spaces.GetSpaceReadState setCallback(String callback)
Description copied from class: HangoutsChatRequest
JSONP
- Overrides:
setCallback in class HangoutsChatRequest<SpaceReadState>
-
setFields
public HangoutsChat.Users.Spaces.GetSpaceReadState 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.GetSpaceReadState 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.GetSpaceReadState 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.GetSpaceReadState 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.GetSpaceReadState 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.GetSpaceReadState 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.GetSpaceReadState 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()
Required. Resource name of the space read state to retrieve. Only supports getting read state for
the calling user. To refer to the calling user, set one of the following: - The `me` alias. For
example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace email address. For example,
`users/[email protected]/spaces/{space}/spaceReadState`. - Their user id. For example,
`users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState
-
setName
public HangoutsChat.Users.Spaces.GetSpaceReadState setName(String name)
Required. Resource name of the space read state to retrieve. Only supports getting read
state for the calling user. To refer to the calling user, set one of the following: - The
`me` alias. For example, `users/me/spaces/{space}/spaceReadState`. - Their Workspace
email address. For example, `users/[email protected]/spaces/{space}/spaceReadState`. -
Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format:
users/{user}/spaces/{space}/spaceReadState
-
set
public HangoutsChat.Users.Spaces.GetSpaceReadState 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