Skip navigation links

waggle.common.modules.followup
Interface XFollowupModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XFollowupModule

public static interface XFollowupModule.Server

extends XAPIInterface.Server

Server interface for the Followup Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	changeFollowupNotify(XObjectID chatID, boolean notify) Change a Followups notify setting for the specified Chat for the current User.
void	changeFollowupNotifyForUser(XObjectID chatID, XObjectID userID, boolean notify) Change a Followups notify setting for the specified Chat for the specified User.
void	changeFollowupNotifyForUsers(XObjectID chatID, List<XObjectID> userIDs, boolean notify) Change a Followups notify setting for the specified Chat for the specified Users.
void	closeFollowup(XObjectID chatID) Close a Followup for the specified Chat for the current User.
void	closeFollowupForUser(XObjectID chatID, XObjectID userID) Close a Followup for the specified Chat for the specified User.
void	closeFollowupForUsers(XObjectID chatID, List<XObjectID> userIDs) Close Followups for the specified Chat for the specified Users.
List<XFollowupChatInfo>	getFollowups() Get all Followups assigned to the current User, across all Conversations.
List<XFollowupChatSummaryInfo>	getFollowupsSummary() Get a summary of all Followups assigned to the current User, across all Conversations.
void	markAllFollowupsRead() Mark all Followups for the current User read.
void	markAllFollowupsReadForConversation(XObjectID conversationID) Mark all Followups for the specified Conversation for the current User read.
void	markAllFollowupsUnread() Mark all Followups for the current User unread.
void	markAllFollowupsUnreadForConversation(XObjectID conversationID) Mark all Followups for the specified Conversation for the current User unread.
void	markFollowupRead(XObjectID chatID) Mark the Followup for the specified Chat for the current User read.
void	markFollowupsRead(List<XObjectID> chatIDs) Mark the Followups for the specified Chats for the current User read.
void	markFollowupsUnread(List<XObjectID> chatIDs) Mark the Followups for the specified Chats for the current User unread.
void	markFollowupUnread(XObjectID chatID) Mark the Followup for the specified Chat for the current User unread.
void	openFollowup(XObjectID chatID, XFollowupOpenInfo openInfo) Open a Followup for the specified Chat and User.
void	openFollowups(XObjectID chatID, List<XFollowupOpenInfo> openInfos) Open Followups for the specified Chat and Users.

Method Detail

openFollowup

void openFollowup(XObjectID chatID,
                  XFollowupOpenInfo openInfo)

Open a Followup for the specified Chat and User. The specified User must be a member of the Conversation.

Parameters:

chatID - The Chat.

openInfo - Info for opening the Followup.

openFollowups

void openFollowups(XObjectID chatID,
                   List<XFollowupOpenInfo> openInfos)

Open Followups for the specified Chat and Users. The specified Users must be members of the Conversation.

Parameters:

chatID - The Chat.

openInfos - Info for opening the Followups.

changeFollowupNotify

void changeFollowupNotify(XObjectID chatID,
                          boolean notify)

Change a Followups notify setting for the specified Chat for the current User.

Parameters:

chatID - The Chat.

notify - new notify setting.

changeFollowupNotifyForUser

void changeFollowupNotifyForUser(XObjectID chatID,
                                 XObjectID userID,
                                 boolean notify)

Change a Followups notify setting for the specified Chat for the specified User.

Parameters:

chatID - The Chat.

userID - The User.

notify - new notify setting.

changeFollowupNotifyForUsers

void changeFollowupNotifyForUsers(XObjectID chatID,
                                  List<XObjectID> userIDs,
                                  boolean notify)

Change a Followups notify setting for the specified Chat for the specified Users.

Parameters:

chatID - The Chat.

userIDs - The Users.

notify - new notify setting.

markFollowupRead

void markFollowupRead(XObjectID chatID)

Mark the Followup for the specified Chat for the current User read.

Parameters:

chatID - The Chat.

markFollowupsRead

void markFollowupsRead(List<XObjectID> chatIDs)

Mark the Followups for the specified Chats for the current User read.

Parameters:

chatIDs - The Chats.

markAllFollowupsReadForConversation

void markAllFollowupsReadForConversation(XObjectID conversationID)

Mark all Followups for the specified Conversation for the current User read.

Parameters:

conversationID - The Conversation.

markAllFollowupsRead

void markAllFollowupsRead()

Mark all Followups for the current User read.

markFollowupUnread

void markFollowupUnread(XObjectID chatID)

Mark the Followup for the specified Chat for the current User unread.

Parameters:

chatID - The Chat.

markFollowupsUnread

void markFollowupsUnread(List<XObjectID> chatIDs)

Mark the Followups for the specified Chats for the current User unread.

Parameters:

chatIDs - The Chats.

markAllFollowupsUnreadForConversation

void markAllFollowupsUnreadForConversation(XObjectID conversationID)

Mark all Followups for the specified Conversation for the current User unread.

Parameters:

conversationID - The Conversation.

markAllFollowupsUnread

void markAllFollowupsUnread()

Mark all Followups for the current User unread.

closeFollowup

void closeFollowup(XObjectID chatID)

Close a Followup for the specified Chat for the current User.

Parameters:

chatID - The Chat.

closeFollowupForUser

void closeFollowupForUser(XObjectID chatID,
                          XObjectID userID)

Close a Followup for the specified Chat for the specified User.

Parameters:

chatID - The Chat.

userID - The User.

closeFollowupForUsers

void closeFollowupForUsers(XObjectID chatID,
                           List<XObjectID> userIDs)

Close Followups for the specified Chat for the specified Users.

Parameters:

chatID - The Chat.

userIDs - The Users.

getFollowups

List<XFollowupChatInfo> getFollowups()

Get all Followups assigned to the current User, across all Conversations.

Returns:

All Followups assigned to the current User, across all Conversations.

getFollowupsSummary

List<XFollowupChatSummaryInfo> getFollowupsSummary()

Get a summary of all Followups assigned to the current User, across all Conversations. Return only a basic summary of the chat.

Returns:

A summary of all Followups assigned to the current User, across all Conversations.

Skip navigation links