com.google.api.services.directory

Class Directory.Members

java.lang.Object

com.google.api.services.directory.Directory.Members

Enclosing class:

Directory

public class Directory.Members
extends Object

The "members" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Directory.Members.Delete
class	Directory.Members.Get
class	Directory.Members.HasMember
class	Directory.Members.Insert
class	Directory.Members.List
class	Directory.Members.Patch
class	Directory.Members.Update

Constructor Summary

Constructors

Constructor and Description
Members()

Method Summary

Modifier and Type	Method and Description
Directory.Members.Delete	delete(String groupKey, String memberKey) Removes a member from a group.
Directory.Members.Get	get(String groupKey, String memberKey) Retrieves a group member's properties.
Directory.Members.HasMember	hasMember(String groupKey, String memberKey) Checks whether the given user is a member of the group.
Directory.Members.Insert	insert(String groupKey, Member content) Adds a user to the specified group.
Directory.Members.List	list(String groupKey) Retrieves a paginated list of all members in a group.
Directory.Members.Patch	patch(String groupKey, String memberKey, Member content) Updates the membership properties of a user in the specified group.
Directory.Members.Update	update(String groupKey, String memberKey, Member content) Updates the membership of a user in the specified group.

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

delete

public Directory.Members.Delete delete(String groupKey,
                                       String memberKey)
                                throws IOException

Removes a member from a group. Create a request for the method "members.delete". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

memberKey - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

Returns:

the request

Throws:

IOException

get

public Directory.Members.Get get(String groupKey,
                                 String memberKey)
                          throws IOException

Retrieves a group member's properties. Create a request for the method "members.get". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

memberKey - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

Returns:

the request

Throws:

IOException

hasMember

public Directory.Members.HasMember hasMember(String groupKey,
                                             String memberKey)
                                      throws IOException

Checks whether the given user is a member of the group. Membership can be direct or nested. Create a request for the method "members.hasMember". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

memberKey - Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique ID.

Returns:

the request

Throws:

IOException

insert

public Directory.Members.Insert insert(String groupKey,
                                       Member content)
                                throws IOException

Adds a user to the specified group. Create a request for the method "members.insert". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

content - the Member

Returns:

the request

Throws:

IOException

list

public Directory.Members.List list(String groupKey)
                            throws IOException

Retrieves a paginated list of all members in a group. Create a request for the method "members.list". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

Returns:

the request

Throws:

IOException

patch

public Directory.Members.Patch patch(String groupKey,
                                     String memberKey,
                                     Member content)
                              throws IOException

Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch). Create a request for the method "members.patch". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

memberKey - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

content - the Member

Returns:

the request

Throws:

IOException

update

public Directory.Members.Update update(String groupKey,
                                       String memberKey,
                                       Member content)
                                throws IOException

Updates the membership of a user in the specified group. Create a request for the method "members.update". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID.

memberKey - Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID.

content - the Member

Returns:

the request

Throws:

IOException