target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Spaces.FindDirectMessage.html Maven / Gradle / Ivy
HangoutsChat.Spaces.FindDirectMessage (Google Chat API v1-rev20240829-2.0.0)
com.google.api.services.chat.v1
Class HangoutsChat.Spaces.FindDirectMessage
- 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<Space>
-
- com.google.api.services.chat.v1.HangoutsChat.Spaces.FindDirectMessage
-
- Enclosing class:
- HangoutsChat.Spaces
public class HangoutsChat.Spaces.FindDirectMessage
extends HangoutsChatRequest<Space>
-
-
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
FindDirectMessage()
Returns the existing direct message with the specified user.
-
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
-
FindDirectMessage
protected FindDirectMessage()
Returns the existing direct message with the specified user. If no direct message space is
found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct
message](/chat/api/guides/v1/spaces/find-direct-message). With [user
authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
returns the direct message space between the specified user and the authenticated user. With
[app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-
app), returns the direct message space between the specified user and the calling Chat app.
Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-
authorize-chat-user) or [app
authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
Create a request for the method "spaces.findDirectMessage".
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.
FindDirectMessage#initialize(com.google.api.client.googleapis.services.AbstractGoogl
eClientRequest)
must be called to initialize this instance immediately after invoking the
constructor.
- 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<Space>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Space>
- Throws:
IOException
-
set$Xgafv
public HangoutsChat.Spaces.FindDirectMessage set$Xgafv(String $Xgafv)
Description copied from class: HangoutsChatRequest
V1 error format.
- Overrides:
set$Xgafv
in class HangoutsChatRequest<Space>
-
setAccessToken
public HangoutsChat.Spaces.FindDirectMessage setAccessToken(String accessToken)
Description copied from class: HangoutsChatRequest
OAuth access token.
- Overrides:
setAccessToken
in class HangoutsChatRequest<Space>
-
setAlt
public HangoutsChat.Spaces.FindDirectMessage setAlt(String alt)
Description copied from class: HangoutsChatRequest
Data format for response.
- Overrides:
setAlt
in class HangoutsChatRequest<Space>
-
setCallback
public HangoutsChat.Spaces.FindDirectMessage setCallback(String callback)
Description copied from class: HangoutsChatRequest
JSONP
- Overrides:
setCallback
in class HangoutsChatRequest<Space>
-
setFields
public HangoutsChat.Spaces.FindDirectMessage setFields(String fields)
Description copied from class: HangoutsChatRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class HangoutsChatRequest<Space>
-
setKey
public HangoutsChat.Spaces.FindDirectMessage 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<Space>
-
setOauthToken
public HangoutsChat.Spaces.FindDirectMessage setOauthToken(String oauthToken)
Description copied from class: HangoutsChatRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class HangoutsChatRequest<Space>
-
setPrettyPrint
public HangoutsChat.Spaces.FindDirectMessage setPrettyPrint(Boolean prettyPrint)
Description copied from class: HangoutsChatRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class HangoutsChatRequest<Space>
-
setQuotaUser
public HangoutsChat.Spaces.FindDirectMessage 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<Space>
-
setUploadType
public HangoutsChat.Spaces.FindDirectMessage setUploadType(String uploadType)
Description copied from class: HangoutsChatRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class HangoutsChatRequest<Space>
-
setUploadProtocol
public HangoutsChat.Spaces.FindDirectMessage setUploadProtocol(String uploadProtocol)
Description copied from class: HangoutsChatRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class HangoutsChatRequest<Space>
-
getName
public String getName()
Required. Resource name of the user to find direct message with. Format: `users/{user}`, where
`{user}` is either the `id` for the
[person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id`
for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the
Directory API. For example, if the People API profile ID is `123456789`, you can find a direct
message with that person by using `users/123456789` as the `name`. When [authenticated as a
user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use
the email as an alias for `{user}`. For example, `users/[email protected]` where
`[email protected]` is the email of the Google Chat user.
-
setName
public HangoutsChat.Spaces.FindDirectMessage setName(String name)
Required. Resource name of the user to find direct message with. Format: `users/{user}`,
where `{user}` is either the `id` for the
[person](https://developers.google.com/people/api/rest/v1/people) from the People API, or
the `id` for the [user](https://developers.google.com/admin-
sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API
profile ID is `123456789`, you can find a direct message with that person by using
`users/123456789` as the `name`. When [authenticated as a
user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you
can use the email as an alias for `{user}`. For example, `users/[email protected]` where
`[email protected]` is the email of the Google Chat user.
-
set
public HangoutsChat.Spaces.FindDirectMessage set(String parameterName,
Object value)
- Overrides:
set
in class HangoutsChatRequest<Space>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy