com.google.api.services.admin.directory

Class Directory.Users

java.lang.Object

com.google.api.services.admin.directory.Directory.Users

Enclosing class:

Directory

public class Directory.Users
extends Object

The "users" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Directory.Users.Aliases The "aliases" collection of methods.
class	Directory.Users.Delete
class	Directory.Users.Get
class	Directory.Users.Insert
class	Directory.Users.List
class	Directory.Users.MakeAdmin
class	Directory.Users.Patch
class	Directory.Users.Photos The "photos" collection of methods.
class	Directory.Users.Undelete
class	Directory.Users.Update

Constructor Summary

Constructors

Constructor and Description
Directory.Users()

Method Summary

Methods

Modifier and Type	Method and Description
Directory.Users.Aliases	aliases() An accessor for creating requests from the Aliases collection.
Directory.Users.Delete	delete(String userKey) Delete user Create a request for the method "users.delete".
Directory.Users.Get	get(String userKey) retrieve user Create a request for the method "users.get".
Directory.Users.Insert	insert(User content) create user.
Directory.Users.List	list() Retrieve either deleted users or all users in a domain (paginated) Create a request for the method "users.list".
Directory.Users.MakeAdmin	makeAdmin(String userKey, UserMakeAdmin content) change admin status of a user Create a request for the method "users.makeAdmin".
Directory.Users.Patch	patch(String userKey, User content) update user.
Directory.Users.Photos	photos() An accessor for creating requests from the Photos collection.
Directory.Users.Undelete	undelete(String userKey, UserUndelete content) Undelete a deleted user Create a request for the method "users.undelete".
Directory.Users.Update	update(String userKey, User content) update user Create a request for the method "users.update".

Methods inherited from class java.lang.Object

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

Constructor Detail

Directory.Users

public Directory.Users()

Method Detail

delete

public Directory.Users.Delete delete(String userKey)
                              throws IOException

Delete user Create a request for the method "users.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:

userKey - Email or immutable Id of the user

Returns:

the request

Throws:

IOException

get

public Directory.Users.Get get(String userKey)
                        throws IOException

retrieve user Create a request for the method "users.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:

userKey - Email or immutable Id of the user

Returns:

the request

Throws:

IOException

insert

public Directory.Users.Insert insert(User content)
                              throws IOException

create user. Create a request for the method "users.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:

content - the User

Returns:

the request

Throws:

IOException

list

public Directory.Users.List list()
                          throws IOException

Retrieve either deleted users or all users in a domain (paginated) Create a request for the method "users.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.

Returns:

the request

Throws:

IOException

makeAdmin

public Directory.Users.MakeAdmin makeAdmin(String userKey,
                                  UserMakeAdmin content)
                                    throws IOException

change admin status of a user Create a request for the method "users.makeAdmin". 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:

userKey - Email or immutable Id of the user as admin

content - the UserMakeAdmin

Returns:

the request

Throws:

IOException

patch

public Directory.Users.Patch patch(String userKey,
                          User content)
                            throws IOException

update user. This method supports patch semantics. Create a request for the method "users.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:

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

content - the User

Returns:

the request

Throws:

IOException

undelete

public Directory.Users.Undelete undelete(String userKey,
                                UserUndelete content)
                                  throws IOException

Undelete a deleted user Create a request for the method "users.undelete". 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:

userKey - The immutable id of the user

content - the UserUndelete

Returns:

the request

Throws:

IOException

update

public Directory.Users.Update update(String userKey,
                            User content)
                              throws IOException

update user Create a request for the method "users.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:

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

content - the User

Returns:

the request

Throws:

IOException

aliases

public Directory.Users.Aliases aliases()

An accessor for creating requests from the Aliases collection.

The typical use is:

   Directory admin = new Directory(...);
   Directory.Aliases.List request = admin.aliases().list(parameters ...)
 

Returns:

the resource collection

photos

public Directory.Users.Photos photos()

An accessor for creating requests from the Photos collection.

The typical use is:

   Directory admin = new Directory(...);
   Directory.Photos.List request = admin.photos().list(parameters ...)
 

Returns:

the resource collection