HangoutsChat.Spaces.Members.List (Google Chat API v1-rev20251118-2.0.0)

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<ListMembershipsResponse>
        
        com.google.api.services.chat.v1.HangoutsChat.Spaces.Members.List

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: HangoutsChat.Spaces.Members

public class HangoutsChat.Spaces.Members.List
extends HangoutsChatRequest<ListMembershipsResponse>

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>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String parent)
Lists memberships in a space.

Constructors
Modifier	Constructor and Description
`protected`	`List(String parent)` Lists memberships in a space.

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`	`getFilter()` Optional.
`Integer`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`String`	`getParent()` Required.
`Boolean`	`getShowGroups()` Optional.
`Boolean`	`getShowInvited()` Optional.
`Boolean`	`getUseAdminAccess()` Optional.
`HangoutsChat.Spaces.Members.List`	`set(String parameterName, Object value)`
`HangoutsChat.Spaces.Members.List`	`set$Xgafv(String $Xgafv)` V1 error format.
`HangoutsChat.Spaces.Members.List`	`setAccessToken(String accessToken)` OAuth access token.
`HangoutsChat.Spaces.Members.List`	`setAlt(String alt)` Data format for response.
`HangoutsChat.Spaces.Members.List`	`setCallback(String callback)` JSONP
`HangoutsChat.Spaces.Members.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`HangoutsChat.Spaces.Members.List`	`setFilter(String filter)` Optional.
`HangoutsChat.Spaces.Members.List`	`setKey(String key)` API key.
`HangoutsChat.Spaces.Members.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`HangoutsChat.Spaces.Members.List`	`setPageSize(Integer pageSize)` Optional.
`HangoutsChat.Spaces.Members.List`	`setPageToken(String pageToken)` Optional.
`HangoutsChat.Spaces.Members.List`	`setParent(String parent)` Required.
`HangoutsChat.Spaces.Members.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`HangoutsChat.Spaces.Members.List`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`HangoutsChat.Spaces.Members.List`	`setShowGroups(Boolean showGroups)` Optional.
`HangoutsChat.Spaces.Members.List`	`setShowInvited(Boolean showInvited)` Optional.
`HangoutsChat.Spaces.Members.List`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`HangoutsChat.Spaces.Members.List`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`HangoutsChat.Spaces.Members.List`	`setUseAdminAccess(Boolean useAdminAccess)` Optional.

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
  - List
```
protected List(String parent)
```
    Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat- app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize- chat-app) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.bot` - `https://www.googleapis.com/auth/chat.app.memberships` (requires [administrator approval](https://support.google.com/a?p=chat-app-auth)) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.memberships.readonly` - `https://www.googleapis.com/auth/chat.memberships` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) - User authentication grants administrator privileges when an administrator account authenticates, `use_admin_access` is `true`, and one of the following authorization scopes is used: - `https://www.googleapis.com/auth/chat.admin.memberships.readonly` - `https://www.googleapis.com/auth/chat.admin.memberships` Create a request for the method "members.list". 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:
    
    parent - Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}
    
    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<ListMembershipsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListMembershipsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public HangoutsChat.Spaces.Members.List set$Xgafv(String $Xgafv)
```
    Description copied from class: HangoutsChatRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class HangoutsChatRequest<ListMembershipsResponse>
  - setAccessToken
```
public HangoutsChat.Spaces.Members.List setAccessToken(String accessToken)
```
    Description copied from class: HangoutsChatRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class HangoutsChatRequest<ListMembershipsResponse>
  - setAlt
```
public HangoutsChat.Spaces.Members.List setAlt(String alt)
```
    Description copied from class: HangoutsChatRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class HangoutsChatRequest<ListMembershipsResponse>
  - setCallback
```
public HangoutsChat.Spaces.Members.List setCallback(String callback)
```
    Description copied from class: HangoutsChatRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class HangoutsChatRequest<ListMembershipsResponse>
  - setFields
```
public HangoutsChat.Spaces.Members.List setFields(String fields)
```
    Description copied from class: HangoutsChatRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class HangoutsChatRequest<ListMembershipsResponse>
  - setKey
```
public HangoutsChat.Spaces.Members.List 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<ListMembershipsResponse>
  - setOauthToken
```
public HangoutsChat.Spaces.Members.List setOauthToken(String oauthToken)
```
    Description copied from class: HangoutsChatRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class HangoutsChatRequest<ListMembershipsResponse>
  - setPrettyPrint
```
public HangoutsChat.Spaces.Members.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: HangoutsChatRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class HangoutsChatRequest<ListMembershipsResponse>
  - setQuotaUser
```
public HangoutsChat.Spaces.Members.List 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<ListMembershipsResponse>
  - setUploadType
```
public HangoutsChat.Spaces.Members.List setUploadType(String uploadType)
```
    Description copied from class: HangoutsChatRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class HangoutsChatRequest<ListMembershipsResponse>
  - setUploadProtocol
```
public HangoutsChat.Spaces.Members.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: HangoutsChatRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class HangoutsChatRequest<ListMembershipsResponse>
  - getParent
```
public String getParent()
```
    Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}
  - setParent
```
public HangoutsChat.Spaces.Members.List setParent(String parent)
```
    Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}
  - getFilter
```
public String getFilter()
```
    Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developer s.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = "HUMAN"` or `member.type != "BOT"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" ``` The following queries are invalid: ``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
  - setFilter
```
public HangoutsChat.Spaces.Members.List setFilter(String filter)
```
    Optional. A query filter. You can filter memberships by a member's role ([`role`](https:/ /developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole )) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/r est/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = "HUMAN"` or `member.type != "BOT"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" ``` The following queries are invalid: ``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.
  - setPageSize
```
public HangoutsChat.Spaces.Members.List setPageSize(Integer pageSize)
```
    Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an `INVALID_ARGUMENT` error.
  - getPageToken
```
public String getPageToken()
```
    Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
  - setPageToken
```
public HangoutsChat.Spaces.Members.List setPageToken(String pageToken)
```
    Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
  - getShowGroups
```
public Boolean getShowGroups()
```
    Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.
  - setShowGroups
```
public HangoutsChat.Spaces.Members.List setShowGroups(Boolean showGroups)
```
    Optional. When `true`, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned.
  - getShowInvited
```
public Boolean getShowInvited()
```
    Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
  - setShowInvited
```
public HangoutsChat.Spaces.Members.List setShowInvited(Boolean showInvited)
```
    Optional. When `true`, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat- user).
  - getUseAdminAccess
```
public Boolean getUseAdminAccess()
```
    Optional. 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 either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.
  - setUseAdminAccess
```
public HangoutsChat.Spaces.Members.List setUseAdminAccess(Boolean useAdminAccess)
```
    Optional. 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 either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api- scopes). Listing app memberships in a space isn't supported when using admin access.
  - set
```
public HangoutsChat.Spaces.Members.List set(String parameterName,
                                            Object value)
```
    Overrides:
    
    set in class HangoutsChatRequest<ListMembershipsResponse>

Class HangoutsChat.Spaces.Members.List

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.chat.v1.HangoutsChatRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getParent

setParent

getFilter

setFilter

getPageSize

setPageSize

getPageToken

setPageToken

getShowGroups

setShowGroups

getShowInvited

setShowInvited

getUseAdminAccess

setUseAdminAccess

set