Skip navigation links

waggle.common.modules.chat
Interface XChatModule.Client

All Superinterfaces:

XAPIInterface, XAPIInterface.Client

Enclosing interface:

XChatModule

public static interface XChatModule.Client

extends XAPIInterface.Client

Client interface for the Chat Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	chatBookmarkClosed(XChatInfo chatInfo, XUserInfo userInfo) Notification that a Chat bookmark has been closed.
void	chatBookmarkOpened(XChatInfo chatInfo, XUserInfo userInfo) Notification that a Chat bookmark has been opened.
void	chatCreated(XChatInfo chatInfo) Notification that a Chat has been created.
void	chatDeleted(XChatInfo chatInfo) Notification that a Chat has been deleted.
void	chatFollowupClosed(XChatInfo chatInfo, XUserInfo userInfo) Notification that a Chat followup has been closed.
void	chatFollowupOpened(XChatInfo chatInfo, XUserInfo userInfo) Notification that a Chat followup has been opened.
void	chatForked(XChatInfo chatInfo) Notification that a Chat has been forked.
void	chatsAllRead(XObjectID conversationID, int ordinal) Notification or Mark all existing chats read.
void	chatsAllUnread(XObjectID conversationID, int ordinal) Notification or mark all existing chats unread.
void	chatsRead(XObjectID conversationID, List<Integer> ordinals) Notification or mark a set of chats read.
void	chatsUnread(XObjectID conversationID, List<Integer> ordinals) Notification or mark a set of chats unread.
void	chatUpdated(XChatInfo chatInfo) Notification that a Chat has been updated.
void	referenceAdded(XObjectID chatConversationID, XObjectID chatID, XObjectID referencedConversationID, XObjectID referencedID) Notification that a Track reference was added to a Chat.
void	referenceRemoved(XObjectID chatConversationID, XObjectID chatID, XObjectID referencedConversationID, XObjectID referencedID) Notification that a Track reference was removed from a Chat.
void	typing(XObjectID userID, XObjectID conversationID) Notification that a User is typing in a Conversation Chat.

Method Detail

typing

void typing(XObjectID userID,
            XObjectID conversationID)

Notification that a User is typing in a Conversation Chat.

Parameters:

userID - The User.

conversationID - The Conversation.

chatCreated

void chatCreated(XChatInfo chatInfo)

Notification that a Chat has been created.

Parameters:

chatInfo - The Chat Info.

chatFollowupOpened

void chatFollowupOpened(XChatInfo chatInfo,
                        XUserInfo userInfo)

Notification that a Chat followup has been opened.

Parameters:

chatInfo - The Chat Info.

userInfo - The User Info.

chatFollowupClosed

void chatFollowupClosed(XChatInfo chatInfo,
                        XUserInfo userInfo)

Notification that a Chat followup has been closed.

Parameters:

chatInfo - The Chat Info.

userInfo - The User Info.

chatBookmarkOpened

void chatBookmarkOpened(XChatInfo chatInfo,
                        XUserInfo userInfo)

Notification that a Chat bookmark has been opened.

Parameters:

chatInfo - The Chat Info.

userInfo - The User Info.

chatBookmarkClosed

void chatBookmarkClosed(XChatInfo chatInfo,
                        XUserInfo userInfo)

Notification that a Chat bookmark has been closed.

Parameters:

chatInfo - The Chat Info.

userInfo - The User Info.

chatForked

void chatForked(XChatInfo chatInfo)

Notification that a Chat has been forked.

Parameters:

chatInfo - The Chat Info.

chatUpdated

void chatUpdated(XChatInfo chatInfo)

Notification that a Chat has been updated.

Parameters:

chatInfo - The Chat Info.

chatDeleted

void chatDeleted(XChatInfo chatInfo)

Notification that a Chat has been deleted.

Parameters:

chatInfo - The Chat Info.

chatsRead

void chatsRead(XObjectID conversationID,
               List<Integer> ordinals)

Notification or mark a set of chats read.

Parameters:

conversationID - The conversation in which to mark the chats read

ordinals - The Chat ordinals that were marked read.

chatsUnread

void chatsUnread(XObjectID conversationID,
                 List<Integer> ordinals)

Notification or mark a set of chats unread.

Parameters:

conversationID - The conversation in which to mark the chats unread

ordinals - The Chat ordinals that were marked unread.

chatsAllRead

void chatsAllRead(XObjectID conversationID,
                  int ordinal)

Notification or Mark all existing chats read.

Parameters:

conversationID - the conversation in which to mark the chats read

ordinal - The maximum ordinal marked read.

chatsAllUnread

void chatsAllUnread(XObjectID conversationID,
                    int ordinal)

Notification or mark all existing chats unread.

Parameters:

conversationID - the conversation in which to mark the chats read

ordinal - The maximum ordinal marked unread.

referenceAdded

void referenceAdded(XObjectID chatConversationID,
                    XObjectID chatID,
                    XObjectID referencedConversationID,
                    XObjectID referencedID)

Notification that a Track reference was added to a Chat.

Parameters:

chatConversationID - The Chat's Conversation.

chatID - The Chat.

referencedConversationID - The references Conversation.

referencedID - The reference.

referenceRemoved

void referenceRemoved(XObjectID chatConversationID,
                      XObjectID chatID,
                      XObjectID referencedConversationID,
                      XObjectID referencedID)

Notification that a Track reference was removed from a Chat.

Parameters:

chatConversationID - The Chat's Conversation.

chatID - The Chat.

referencedConversationID - The references Conversation.

referencedID - The reference.

Skip navigation links