Skip navigation links

waggle.common.modules.bookmark
Interface XBookmarkModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XBookmarkModule

public static interface XBookmarkModule.Server

extends XAPIInterface.Server

Server interface for the Bookmark Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	closeBookmark(XObjectID chatID) Close a Bookmark for the specified Chat for the current User.
List<XChatInfo>	getBookmarks() Get all Bookmarks assigned to the current User, across all Conversations.
List<XBookmarkSummaryInfo>	getBookmarksSummary() Get a basic summary of all the user's bookmarks.
void	openBookmark(XObjectID chatID) Open a Bookmark for the specified Chat for the current User.

Method Detail

openBookmark

void openBookmark(XObjectID chatID)

Open a Bookmark for the specified Chat for the current User.

Parameters:

chatID - The Chat.

closeBookmark

void closeBookmark(XObjectID chatID)

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

Parameters:

chatID - The Chat.

getBookmarks

List<XChatInfo> getBookmarks()

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

Returns:

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

getBookmarksSummary

List<XBookmarkSummaryInfo> getBookmarksSummary()

Get a basic summary of all the user's bookmarks.

Returns:

a basic summary of all the user's bookmarks

Skip navigation links