Package net.bluemind.directory.api

Interface IDirEntryPhotoSupport

All Known Subinterfaces:

IMailshare, IUser

public interface IDirEntryPhotoSupport

Method Summary

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

Method Details

setPhoto

@POST
@Path("{uid}/photo")
@Consumes("image/png")
void setPhoto(@PathParam("uid")
 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("{uid}/photo")
@Produces("image/png")
byte[] getPhoto(@PathParam("uid")
 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("{uid}/photo")
void deletePhoto(@PathParam("uid")
 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("{uid}/icon")
@Produces("image/png")
byte[] getIcon(@PathParam("uid")
 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