com.google.api.services.admin.directory

Class Directory.Members

java.lang.Object

com.google.api.services.admin.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.Insert
class	Directory.Members.List
class	Directory.Members.Patch
class	Directory.Members.Update

Constructor Summary

Constructors

Constructor and Description
Directory.Members()

Method Summary

Methods

Modifier and Type	Method and Description
Directory.Members.Delete	delete(String groupKey, String memberKey) Remove membership.
Directory.Members.Get	get(String groupKey, String memberKey) Retrieve Group Member Create a request for the method "members.get".
Directory.Members.Insert	insert(String groupKey, Member content) Add user to the specified group.
Directory.Members.List	list(String groupKey) Retrieve all members in a group (paginated) Create a request for the method "members.list".
Directory.Members.Patch	patch(String groupKey, String memberKey, Member content) Update membership of a user in the specified group.
Directory.Members.Update	update(String groupKey, String memberKey, Member content) Update 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

Directory.Members

public Directory.Members()

Method Detail

delete

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

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

Parameters:

groupKey - Email or immutable Id of the group

memberKey - Email or immutable Id of the member

Returns:

the request

Throws:

IOException

get

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

Retrieve Group Member Create a request for the method "members.get". This request holds the parameters needed by the the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

groupKey - Email or immutable Id of the group

memberKey - Email or immutable Id of the member

Returns:

the request

Throws:

IOException

insert

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

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

Parameters:

groupKey - Email or immutable Id of the group

content - the Member

Returns:

the request

Throws:

IOException

list

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

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

Parameters:

groupKey - Email or immutable Id of the group

Returns:

the request

Throws:

IOException

patch

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

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

Parameters:

groupKey - Email or immutable Id of the group. If Id, it should match with id of group object

memberKey - Email or immutable Id of the user. If Id, it should match with id of member object

content - the Member

Returns:

the request

Throws:

IOException

update

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

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

Parameters:

groupKey - Email or immutable Id of the group. If Id, it should match with id of group object

memberKey - Email or immutable Id of the user. If Id, it should match with id of member object

content - the Member

Returns:

the request

Throws:

IOException