net.bluemind.directory.api

Interface IDirEntryPhotoSupport

All Known Subinterfaces:

IInCoreUser, IMailshare, IUser

All Known Implementing Classes:

MailshareService, UserService

public interface IDirEntryPhotoSupport

Method Summary

Modifier and Type	Method and Description
void	deletePhoto(java.lang.String uid) Delete the photo associated to the DirEntry
byte[]	getIcon(java.lang.String uid) Retrieve the icon/avatar associated to the DirEntry
byte[]	getPhoto(java.lang.String uid) Retrieve the photo associated to the DirEntry
void	setPhoto(java.lang.String uid, byte[] photo) Set a photo, needs to be in PNG format

Method Detail

setPhoto

@POST
 @Path(value="{uid}/photo")
 @Consumes(value="image/png")
void setPhoto(@PathParam(value="uid")
                                                                              java.lang.String uid,
                                                                              byte[] photo)
                                                                       throws ServerFault

Set a photo, needs to be in PNG format

Parameters:

uid - the directory entry uid

photo - the photo data

Throws:

ServerFault - common error object

getPhoto

@GET
 @Path(value="{uid}/photo")
 @Produces(value="image/png")
byte[] getPhoto(@PathParam(value="uid")
                                                                               java.lang.String uid)
                                                                        throws ServerFault

Retrieve the photo associated to the DirEntry

Parameters:

uid - the directory entry uid

Returns:

the photo data, PNG format

Throws:

ServerFault - common error object

deletePhoto

@DELETE
 @Path(value="{uid}/photo")
void deletePhoto(@PathParam(value="uid")
                                                     java.lang.String uid)
                                              throws ServerFault

Delete the photo associated to the DirEntry

Parameters:

uid - the directory entry uid

Throws:

ServerFault - common error object

getIcon

@GET
 @Path(value="{uid}/icon")
 @Produces(value="image/png")
byte[] getIcon(@PathParam(value="uid")
                                                                             java.lang.String uid)
                                                                      throws ServerFault

Retrieve the icon/avatar associated to the DirEntry

Parameters:

uid - the directory entry uid

Returns:

the icon data, PNG format

Throws:

ServerFault - common error object