target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Spaces.Members.Get.html Maven / Gradle / Ivy
HangoutsChat.Spaces.Members.Get (Google Chat API v1-rev20240829-2.0.0)
com.google.api.services.chat.v1
Class HangoutsChat.Spaces.Members.Get
- 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<Membership>
-
- com.google.api.services.chat.v1.HangoutsChat.Spaces.Members.Get
-
- Enclosing class:
- HangoutsChat.Spaces.Members
public class HangoutsChat.Spaces.Members.Get
extends HangoutsChatRequest<Membership>
-
-
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
Get(String name)
Returns details about a membership.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
String
getName()
Required.
Boolean
getUseAdminAccess()
[ Developer Preview](https://developers.google.com/workspace/preview).
HangoutsChat.Spaces.Members.Get
set(String parameterName,
Object value)
HangoutsChat.Spaces.Members.Get
set$Xgafv(String $Xgafv)
V1 error format.
HangoutsChat.Spaces.Members.Get
setAccessToken(String accessToken)
OAuth access token.
HangoutsChat.Spaces.Members.Get
setAlt(String alt)
Data format for response.
HangoutsChat.Spaces.Members.Get
setCallback(String callback)
JSONP
HangoutsChat.Spaces.Members.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.
HangoutsChat.Spaces.Members.Get
setKey(String key)
API key.
HangoutsChat.Spaces.Members.Get
setName(String name)
Required.
HangoutsChat.Spaces.Members.Get
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
HangoutsChat.Spaces.Members.Get
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
HangoutsChat.Spaces.Members.Get
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
HangoutsChat.Spaces.Members.Get
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
HangoutsChat.Spaces.Members.Get
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
HangoutsChat.Spaces.Members.Get
setUseAdminAccess(Boolean useAdminAccess)
[Developer Preview](https://developers.google.com/workspace/preview).
-
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
-
Get
protected Get(String name)
Returns details about a membership. For an example, see [Get details about a user's or Google
Chat app's membership](https://developers.google.com/workspace/chat/get-members). Requires
[authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports
[app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-
app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-
authorize-chat-user).
Create a request for the method "members.get".
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. HangoutsChat.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must be
called to initialize this instance immediately after invoking the constructor.
- Parameters:
name
- Required. Resource name of the membership to retrieve. To get the app's own membership [by using
user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-
chat-user), you can optionally use `spaces/{space}/members/app`. Format:
`spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a
user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you
can use the user's email as an alias for `{member}`. For example,
`spaces/{space}/members/[email protected]` where `[email protected]` is the email of the
Google Chat user.
- 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<Membership>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Membership>
- Throws:
IOException
-
set$Xgafv
public HangoutsChat.Spaces.Members.Get set$Xgafv(String $Xgafv)
Description copied from class: HangoutsChatRequest
V1 error format.
- Overrides:
set$Xgafv
in class HangoutsChatRequest<Membership>
-
setAccessToken
public HangoutsChat.Spaces.Members.Get setAccessToken(String accessToken)
Description copied from class: HangoutsChatRequest
OAuth access token.
- Overrides:
setAccessToken
in class HangoutsChatRequest<Membership>
-
setAlt
public HangoutsChat.Spaces.Members.Get setAlt(String alt)
Description copied from class: HangoutsChatRequest
Data format for response.
- Overrides:
setAlt
in class HangoutsChatRequest<Membership>
-
setCallback
public HangoutsChat.Spaces.Members.Get setCallback(String callback)
Description copied from class: HangoutsChatRequest
JSONP
- Overrides:
setCallback
in class HangoutsChatRequest<Membership>
-
setFields
public HangoutsChat.Spaces.Members.Get setFields(String fields)
Description copied from class: HangoutsChatRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class HangoutsChatRequest<Membership>
-
setKey
public HangoutsChat.Spaces.Members.Get 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<Membership>
-
setOauthToken
public HangoutsChat.Spaces.Members.Get setOauthToken(String oauthToken)
Description copied from class: HangoutsChatRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class HangoutsChatRequest<Membership>
-
setPrettyPrint
public HangoutsChat.Spaces.Members.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: HangoutsChatRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class HangoutsChatRequest<Membership>
-
setQuotaUser
public HangoutsChat.Spaces.Members.Get 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<Membership>
-
setUploadType
public HangoutsChat.Spaces.Members.Get setUploadType(String uploadType)
Description copied from class: HangoutsChatRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class HangoutsChatRequest<Membership>
-
setUploadProtocol
public HangoutsChat.Spaces.Members.Get setUploadProtocol(String uploadProtocol)
Description copied from class: HangoutsChatRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class HangoutsChatRequest<Membership>
-
getName
public String getName()
Required. Resource name of the membership to retrieve. To get the app's own membership [by using
user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-
user), you can optionally use `spaces/{space}/members/app`. Format:
`spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a
user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use
the user's email as an alias for `{member}`. For example,
`spaces/{space}/members/[email protected]` where `[email protected]` is the email of the Google
Chat user.
-
setName
public HangoutsChat.Spaces.Members.Get setName(String name)
Required. Resource name of the membership to retrieve. To get the app's own membership
[by using user authentication](https://developers.google.com/workspace/chat/authenticate-
authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format:
`spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as
a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user),
you can use the user's email as an alias for `{member}`. For example,
`spaces/{space}/members/[email protected]` where `[email protected]` is the email of the
Google Chat user.
-
getUseAdminAccess
public Boolean getUseAdminAccess()
[ Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs
[ using the user's Google Workspace administrator privileges. The calling user must be a Google
[ Workspace administrator with the [manage chat and spaces conversations
[ privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or
[ `chat.admin.memberships.readonly` [OAuth 2.0
[ scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).
[ Getting app memberships in a space isn't supported when using admin access.
[
-
setUseAdminAccess
public HangoutsChat.Spaces.Members.Get setUseAdminAccess(Boolean useAdminAccess)
[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the
method runs using the user's Google Workspace administrator privileges. The calling user
must be a Google Workspace administrator with the [manage chat and spaces conversations
privilege](https://support.google.com/a/answer/13369245). Requires the
`chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0
scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-
scopes). Getting app memberships in a space isn't supported when using admin access.
-
set
public HangoutsChat.Spaces.Members.Get set(String parameterName,
Object value)
- Overrides:
set
in class HangoutsChatRequest<Membership>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy