target.apidocs.com.google.api.services.directory.Directory.Users.Photos.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.Photos (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.Photos



java.lang.Object


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







Enclosing class:
Directory.Users




public class Directory.Users.Photos
extends Object
The "photos" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Directory.Users.Photos.Delete 


class 
Directory.Users.Photos.Get 


class 
Directory.Users.Photos.Patch 


class 
Directory.Users.Photos.Update 









Constructor Summary

Constructors 

Constructor and Description


Photos() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Directory.Users.Photos.Delete
delete(String userKey)
Removes the user's photo.



Directory.Users.Photos.Get
get(String userKey)
Retrieves the user's photo.



Directory.Users.Photos.Patch
patch(String userKey,
     UserPhoto content)
Adds a photo for the user.



Directory.Users.Photos.Update
update(String userKey,
      UserPhoto content)
Adds a photo for the user.







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














Constructor Detail





Photos
public Photos()









Method Detail





delete
public Directory.Users.Photos.Delete delete(String userKey)
                                     throws IOException
Removes the user's photo.

 Create a request for the method "photos.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.Photos.Get get(String userKey)
                               throws IOException
Retrieves the user's photo.

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








patch
public Directory.Users.Photos.Patch patch(String userKey,
                                          UserPhoto content)
                                   throws IOException
Adds a photo for the user. This method supports [patch semantics](/admin-
 sdk/directory/v1/guides/performance#patch).

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








update
public Directory.Users.Photos.Update update(String userKey,
                                            UserPhoto content)
                                     throws IOException
Adds a photo for the user.

 Create a request for the method "photos.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 UserPhoto
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.Photos.Delete`
`class`	`Directory.Users.Photos.Get`
`class`	`Directory.Users.Photos.Patch`
`class`	`Directory.Users.Photos.Update`

Modifier and Type	Method and Description
`Directory.Users.Photos.Delete`	`delete(String userKey)` Removes the user's photo.
`Directory.Users.Photos.Get`	`get(String userKey)` Retrieves the user's photo.
`Directory.Users.Photos.Patch`	`patch(String userKey, UserPhoto content)` Adds a photo for the user.
`Directory.Users.Photos.Update`	`update(String userKey, UserPhoto content)` Adds a photo for the user.