target.apidocs.com.google.api.services.directory.Directory.Users.Aliases.html Maven / Gradle / Ivy

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

There is a newer version: directory_v1-rev20240709-2.0.0

Show newest version







Directory.Users.Aliases (Admin SDK API directory_v1-rev20220802-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.directory
Class Directory.Users.Aliases



java.lang.Object


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







Enclosing class:
Directory.Users




public class Directory.Users.Aliases
extends Object
The "aliases" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Directory.Users.Aliases.Delete 


class 
Directory.Users.Aliases.Insert 


class 
Directory.Users.Aliases.List 


class 
Directory.Users.Aliases.Watch 









Constructor Summary

Constructors 

Constructor and Description


Aliases() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Directory.Users.Aliases.Delete
delete(String userKey,
      String alias)
Removes an alias.



Directory.Users.Aliases.Insert
insert(String userKey,
      Alias content)
Adds an alias.



Directory.Users.Aliases.List
list(String userKey)
Lists all aliases for a user.



Directory.Users.Aliases.Watch
watch(String userKey,
     Channel content)
Watches for changes in users list.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Aliases
public Aliases()









Method Detail





delete
public Directory.Users.Aliases.Delete delete(String userKey,
                                             String alias)
                                      throws IOException
Removes an alias.

 Create a request for the method "aliases.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.
alias - The alias to be removed.
Returns:
the request
Throws:
IOException








insert
public Directory.Users.Aliases.Insert insert(String userKey,
                                             Alias content)
                                      throws IOException
Adds an alias.

 Create a request for the method "aliases.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:
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 Alias
Returns:
the request
Throws:
IOException








list
public Directory.Users.Aliases.List list(String userKey)
                                  throws IOException
Lists all aliases for a user.

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








watch
public Directory.Users.Aliases.Watch watch(String userKey,
                                           Channel content)
                                    throws IOException
Watches for changes in users list.

 Create a request for the method "aliases.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:
userKey - Email or immutable ID of the user
content - the Channel
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–2022 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Directory.Users.Aliases.Delete`
`class`	`Directory.Users.Aliases.Insert`
`class`	`Directory.Users.Aliases.List`
`class`	`Directory.Users.Aliases.Watch`

Modifier and Type	Method and Description
`Directory.Users.Aliases.Delete`	`delete(String userKey, String alias)` Removes an alias.
`Directory.Users.Aliases.Insert`	`insert(String userKey, Alias content)` Adds an alias.
`Directory.Users.Aliases.List`	`list(String userKey)` Lists all aliases for a user.
`Directory.Users.Aliases.Watch`	`watch(String userKey, Channel content)` Watches for changes in users list.