com.iland.core.web.rest.api

Interface UserInboxResource

@Path(value="/users")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface UserInboxResource

User Inbox Resource Interface v1.

Author:

Brett Snyder

Method Summary

Modifier and Type	Method and Description
void	batchInboxUpdate(String username, BatchInboxUpdateRequest batchUpdate) Batch update operation for multiple messages.
InboxMessageResponse	deleteMessage(String username, String uuid) Delete an inbox message given its uuid.
InboxMessageResponse	getMessage(String username, String uuid) Returns an inbox message given its uuid.
InboxMessageListResponse	getMessageHeaders(String username, InboxMessageFilterParams filters) Returns user's message headers (does not return message content) for the given folder.
MessageCountResponse	getUnreadMessageCount(String username, MessageFolder folder) Returns the number of unread messages for a given user.
void	markAllMessagesAsRead(String username, InboxMarkAllAsReadRequest request) Mark all messages in a folder as read.
InboxMessageResponse	markMessageAsRead(String username, String uuid) Mark a message as read given its uuid.
InboxMessageResponse	moveMessage(String username, String uuid, MoveMessageRequest spec) Move a user message to the specified folder.

Method Detail

moveMessage

@POST
 @Path(value="/{username}/messages/{uuid}/actions/move")
 @Consumes(value="application/json")
InboxMessageResponse moveMessage(@PathParam(value="username")
                                                                                                                                     String username,
                                                                                                                                     @PathParam(value="uuid")
                                                                                                                                     String uuid,
                                                                                                                                     MoveMessageRequest spec)

Move a user message to the specified folder.

Parameters:

username - unique username as seen by iland AD

uuid - unique message identifier

spec - specification for moving the inbox message

Returns:

inbox message

getMessage

@GET
 @Path(value="/{username}/messages/{uuid}")
InboxMessageResponse getMessage(@PathParam(value="username")
                                                                                 String username,
                                                                                 @PathParam(value="uuid")
                                                                                 String uuid)

Returns an inbox message given its uuid.

Parameters:

username - unique username as seen by iland AD

uuid - unique message identifier

Returns:

inbox message

markMessageAsRead

@POST
 @Path(value="/{username}/messages/{uuid}/actions/mark-as-read")
InboxMessageResponse markMessageAsRead(@PathParam(value="username")
                                                                                                              String username,
                                                                                                              @PathParam(value="uuid")
                                                                                                              String uuid)

Mark a message as read given its uuid.

Parameters:

username - unique username as seen by iland AD

uuid - unique message identifier

Returns:

inbox message

batchInboxUpdate

@POST
 @Consumes(value="application/json")
 @Path(value="/{username}/messages/actions/batch-update")
void batchInboxUpdate(@PathParam(value="username")
                                                                                                                           String username,
                                                                                                                           BatchInboxUpdateRequest batchUpdate)

Batch update operation for multiple messages. If the 'folder' field is not specified, the batch update is applied to all messages specified with the 'uuids' field. If the 'folder' field is specified, the 'uuids' field is used to declare messages that should be excluded from the batch update that are within the specified folder.

Parameters:

username - users username

markAllMessagesAsRead

@POST
 @Path(value="/{username}/messages/actions/mark-all-as-read")
void markAllMessagesAsRead(@PathParam(value="username")
                                                                                               String username,
                                                                                               InboxMarkAllAsReadRequest request)

Mark all messages in a folder as read.

Parameters:

username - users username

request - request specifying folder to operate on

deleteMessage

@DELETE
 @Path(value="/{username}/messages/{uuid}")
InboxMessageResponse deleteMessage(@PathParam(value="username")
                                                                                       String username,
                                                                                       @PathParam(value="uuid")
                                                                                       String uuid)

Delete an inbox message given its uuid.

Parameters:

username - unique username as seen by iland AD

uuid - unique message identifier

Returns:

inbox message

getUnreadMessageCount

@GET
 @Path(value="/{username}/unread-message-count")
MessageCountResponse getUnreadMessageCount(@PathParam(value="username")
                                                                                                 String username,
                                                                                                 @QueryParam(value="folder")
                                                                                                 MessageFolder folder)

Returns the number of unread messages for a given user.

Parameters:

username - String username

folder - String folder name

Returns:

MessageCountResponse message count

getMessageHeaders

@GET
 @Path(value="/{username}/messages")
InboxMessageListResponse getMessageHeaders(@PathParam(value="username")
                                                                                     String username,
                                                                                     @BeanParam
                                                                                     InboxMessageFilterParams filters)

Returns user's message headers (does not return message content) for the given folder.

Parameters:

username - unique username as seen by iland AD

Returns:

inbox message headers