target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Spaces.Members.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-chat Show documentation

There is a newer version: v1-rev20241217-2.0.0

Show newest version







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











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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 


class 
HangoutsChat.Spaces.Members.Patch 









Constructor Summary

Constructors 

Constructor and Description


Members() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HangoutsChat.Spaces.Members.Create
create(String parent,
      Membership content)
Creates a membership for the calling Chat app, a user, or a Google Group.



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.



HangoutsChat.Spaces.Members.Patch
patch(String name,
     Membership content)
Updates a membership.







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 membership for the calling Chat app, a user, or a Google Group. Creating memberships
 for other Chat apps isn't supported. 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/workspace/chat/authenticate-
 authorize-chat-user). For example usage, see: - [Invite or add a user to a
 space](https://developers.google.com/workspace/chat/create-members#create-user-membership). -
 [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-
 members#create-group-membership). - [Add the Chat app to a
 space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-
 api).

 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 [Remove a user or a Google Chat app from a
 space](https://developers.google.com/workspace/chat/delete-members). Requires [user
 authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

 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/[email protected]` where `[email protected]` 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 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 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 [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.
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 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. 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.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








patch
public HangoutsChat.Spaces.Members.Patch patch(String name,
                                               Membership content)
                                        throws IOException
Updates a membership. For an example, see [Update a user's membership in a
 space](https://developers.google.com/workspace/chat/update-members). Requires [user
 authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).

 Create a request for the method "members.patch".

 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 - Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
content - the Membership
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

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`
`class`	`HangoutsChat.Spaces.Members.Patch`

Modifier and Type	Method and Description
`HangoutsChat.Spaces.Members.Create`	`create(String parent, Membership content)` Creates a membership for the calling Chat app, a user, or a Google Group.
`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.
`HangoutsChat.Spaces.Members.Patch`	`patch(String name, Membership content)` Updates a membership.