com.google.api.services.directory

Class Directory.Users

java.lang.Object

com.google.api.services.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.SignOut
class	Directory.Users.Undelete
class	Directory.Users.Update
class	Directory.Users.Watch

Constructor Summary

Constructors

Constructor and Description
Users()

Method Summary

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) Deletes a user.
Directory.Users.Get	get(String userKey) Retrieves a user.
Directory.Users.Insert	insert(User content) Creates a user.
Directory.Users.List	list() Retrieves a paginated list of either deleted users or all users in a domain.
Directory.Users.MakeAdmin	makeAdmin(String userKey, UserMakeAdmin content) Makes a user a super administrator.
Directory.Users.Patch	patch(String userKey, User content) Updates a user using patch semantics.
Directory.Users.Photos	photos() An accessor for creating requests from the Photos collection.
Directory.Users.SignOut	signOut(String userKey) Sign a user out of all web and device sessions and reset their sign-in cookies.
Directory.Users.Undelete	undelete(String userKey, UserUndelete content) Undeletes a deleted user.
Directory.Users.Update	update(String userKey, User content) Updates a user.
Directory.Users.Watch	watch(Channel content) Watch for changes in users list Create a request for the method "users.watch".

Methods inherited from class java.lang.Object

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

Constructor Detail

Users

public Users()

Method Detail

delete

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

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

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

Returns:

the request

Throws:

IOException

get

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

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

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

Returns:

the request

Throws:

IOException

insert

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

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

content - the User

Returns:

the request

Throws:

IOException

list

public Directory.Users.List list()
                          throws IOException

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

Returns:

the request

Throws:

IOException

makeAdmin

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

Makes a user a super administrator. Create a request for the method "users.makeAdmin". 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:

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

content - the UserMakeAdmin

Returns:

the request

Throws:

IOException

patch

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

Updates a user using patch semantics. The update method should be used instead, since it also supports patch semantics and has better performance. This method is unable to clear fields that contain repeated objects (`addresses`, `phones`, etc). Use the update method instead. Create a request for the method "users.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:

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

content - the User

Returns:

the request

Throws:

IOException

signOut

public Directory.Users.SignOut signOut(String userKey)
                                throws IOException

Sign a user out of all web and device sessions and reset their sign-in cookies. User will have to sign in by authenticating again. Create a request for the method "users.signOut". 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:

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

Returns:

the request

Throws:

IOException

undelete

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

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

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

Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to `null` will be cleared. Create a request for the method "users.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:

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

content - the User

Returns:

the request

Throws:

IOException

watch

public Directory.Users.Watch watch(Channel content)
                            throws IOException

Watch for changes in users list Create a request for the method "users.watch". 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:

content - the Channel

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