com.google.api.services.chat.v1

Class HangoutsChat.Spaces.Members

java.lang.Object

com.google.api.services.chat.v1.HangoutsChat.Spaces.Members

Enclosing class:

HangoutsChat.Spaces

public class HangoutsChat.Spaces.Members
extends Object

The "members" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HangoutsChat.Spaces.Members.Create
class	HangoutsChat.Spaces.Members.Delete
class	HangoutsChat.Spaces.Members.Get
class	HangoutsChat.Spaces.Members.List

Constructor Summary

Constructors

Constructor and Description
Members()

Method Summary

Modifier and Type	Method and Description
HangoutsChat.Spaces.Members.Create	create(String parent, Membership content) Creates a human membership or app membership for the calling app.
HangoutsChat.Spaces.Members.Delete	delete(String name) Deletes a membership.
HangoutsChat.Spaces.Members.Get	get(String name) Returns details about a membership.
HangoutsChat.Spaces.Members.List	list(String parent) Lists memberships in a space.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Members

public Members()

Method Detail

create

public HangoutsChat.Spaces.Members.Create create(String parent,
                                                 Membership content)
                                          throws IOException

Creates a human membership or app membership for the calling app. Creating memberships for other apps isn't supported. For an example, see [ Create a membership](https://developers.google.com/chat/api/guides/v1/members/create). When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). To specify the member to add, set the `membership.member.name` in the `CreateMembershipRequest`: - To add the calling app to a space or a direct message between two human users, use `users/app`. Unable to add other apps to the space. - To add a human user, use `users/{user}`, where `{user}` can be the email address for the user. For users in the same Workspace organization `{user}` can also be the `id` for the person from the People API, or the `id` for the user in the Directory API. For example, if the People API Person profile ID for `user@example.com` is `123456789`, you can add the user to the space by setting the `membership.member.name` to `users/user@example.com` or `users/123456789`. Create a request for the method "members.create". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The resource name of the space for which to create the membership. Format: spaces/{space}

content - the Membership

Returns:

the request

Throws:

IOException

delete

public HangoutsChat.Spaces.Members.Delete delete(String name)
                                          throws IOException

Deletes a membership. For an example, see [Delete a membership](https://developers.google.com/chat/api/guides/v1/members/delete). Requires [user authentication](https://developers.google.com/chat/api/guides/auth/users). Create a request for the method "members.delete". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the `chat.memberships` scope and `spaces/{space}/members/{member}` format. You can use the email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. When deleting an app membership, requires the `chat.memberships.app` scope and `spaces/{space}/members/app` format. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app`.

Returns:

the request

Throws:

IOException

get

public HangoutsChat.Spaces.Members.Get get(String name)
                                    throws IOException

Returns details about a membership. For an example, see [Get a membership](https://developers.google.com/chat/api/guides/v1/members/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Supports [app authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Create a request for the method "members.get". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of the membership to retrieve. To get the app's own membership, 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/chat/api/guides/auth/users), you can use the user's email as an alias for `{member}`. For example, `spaces/{space}/members/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user.

Returns:

the request

Throws:

IOException

list

public HangoutsChat.Spaces.Members.List list(String parent)
                                      throws IOException

Lists memberships in a space. For an example, see [List memberships](https://developers.google.com/chat/api/guides/v1/members/list). Listing memberships with [app authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) 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/chat/api/guides/auth/users) lists memberships in spaces that the authenticated user has access to. Requires [authentication](https://developers.google.com/chat/api/guides/auth). Supports [app authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). Create a request for the method "members.list". This request holds the parameters needed by the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space}

Returns:

the request

Throws:

IOException