Skip navigation links

waggle.common.modules.profile
Interface XProfileModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XProfileModule

public static interface XProfileModule.Server

extends XAPIInterface.Server

Server interface for the Profile Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	defaultProfileNotificationSettings(XObjectID userID) Set default notification settings for the specified User.
void	deleteProfilePicture() Delete any picture for the current User.
XProfileInfo	getMyProfile() Get current User's Profile info.
InputStream	getOriginalProfilePicture(XObjectID userID) Get any original picture for the specified User.
XProfileInfo	getProfile(XObjectID userID) Get another User's Profile info.
List<XProfileNotificationInfo>	getProfileNotificationSettings(XObjectID userID) Get all notification settings for the specified User.
InputStream	getScaledProfilePicture(XObjectID userID) Get any scaled picture for the specified User.
void	setProfileNotificationSettings(XObjectID userID, List<XProfileNotificationInfo> notificationInfos) Set all notification settings for the specified User.
XProfileInfo	updateMyProfile(XUpdater updater) Update the current User's Profile info.
XProfileInfo	updateProfile(XObjectID userID, XUpdater updater) Update a User's Profile info.
void	uploadProfilePicture(XAPIInputStream inputStream, String mimeType, long length) Upload a picture for the current User's profile.
String	uploadProfilePictureToDataUri(XAPIInputStream inputStream, String mimeType, long length) Convert an image to a scaled image Data URI.

Method Detail

getMyProfile

XProfileInfo getMyProfile()

Get current User's Profile info.

Returns:

The current User's Profile info.

updateMyProfile

XProfileInfo updateMyProfile(XUpdater updater)

Update the current User's Profile info.

Parameters:

updater - Changes to the Profile info.

Returns:

The updated User's Profile info.

getProfile

XProfileInfo getProfile(XObjectID userID)

Get another User's Profile info.

Parameters:

userID - The User.

Returns:

The specified User's Profile info.

getProfileNotificationSettings

List<XProfileNotificationInfo> getProfileNotificationSettings(XObjectID userID)

Get all notification settings for the specified User.

Parameters:

userID - The User.

Returns:

The notification settings for the specified User.

setProfileNotificationSettings

void setProfileNotificationSettings(XObjectID userID,
                                    List<XProfileNotificationInfo> notificationInfos)

Set all notification settings for the specified User.

Parameters:

userID - The User.

notificationInfos - The new notification settings for the specified User.

defaultProfileNotificationSettings

void defaultProfileNotificationSettings(XObjectID userID)

Set default notification settings for the specified User.

Parameters:

userID - The User.

updateProfile

XProfileInfo updateProfile(XObjectID userID,
                           XUpdater updater)

Update a User's Profile info.

Parameters:

userID - The User.

updater - Changes to the Profile info.

Returns:

The updated User's Profile info.

uploadProfilePicture

void uploadProfilePicture(XAPIInputStream inputStream,
                          String mimeType,
                          long length)

Upload a picture for the current User's profile.

Parameters:

inputStream - The InputStream containing the picture.

mimeType - The mimetype of the picture.

length - The length of the picture.

uploadProfilePictureToDataUri

String uploadProfilePictureToDataUri(XAPIInputStream inputStream,
                                     String mimeType,
                                     long length)

Convert an image to a scaled image Data URI.

Parameters:

inputStream - The InputStream containing the picture.

mimeType - The mimetype of the picture.

length - The length of the picture.

Returns:

The Data URI.

getOriginalProfilePicture

InputStream getOriginalProfilePicture(XObjectID userID)

Get any original picture for the specified User.

Parameters:

userID - The User.

Returns:

The original picture or null.

getScaledProfilePicture

InputStream getScaledProfilePicture(XObjectID userID)

Get any scaled picture for the specified User.

Parameters:

userID - The User.

Returns:

The scaled picture or null.

deleteProfilePicture

void deleteProfilePicture()

Delete any picture for the current User.

Skip navigation links