Skip navigation links

waggle.common.modules.widget
Interface XWidgetModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XWidgetModule

public static interface XWidgetModule.Server

extends XAPIInterface.Server

Server interface for the Widget Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XWidgetInfo	createWidget(XObjectID conversationID, XObjectID gadgetID, String type, String name, boolean enabled, List<XPropertyInfo> propertyInfos) Create a new Widget.
XObjectID	createWidgetChat(XObjectID widgetID, String chatText) Create a Widget related Chat message.
XObjectID	createWidgetComment(XObjectID widgetID, XObjectID chatID, String chatText) Create a Widget related Comment message.
List<XWidgetInfo>	getAllWidgets(XObjectID conversationID) Get all widgets for a given conversation, whether active or not.
List<XWidgetInfo>	getEnabledWidgets(XObjectID conversationID) Get all the active Widgets for a given Conversation.
XWidgetInfo	getWidget(XObjectID widgetID) Get Widget.
void	removeWidget(XObjectID widgetID) Remove a Widget.
XWidgetInfo	setWidgetEnabled(XObjectID widgetID, boolean enabled) Set Widget enabled state.
XWidgetInfo	setWidgetName(XObjectID widgetID, String name) Set Widget name.
void	updateWidgetSoon(XObjectID widgetID) Called by client to indicate widget should perform any automatic updates "soon".

Method Detail

createWidget

XWidgetInfo createWidget(XObjectID conversationID,
                         XObjectID gadgetID,
                         String type,
                         String name,
                         boolean enabled,
                         List<XPropertyInfo> propertyInfos)

Create a new Widget.

Parameters:

conversationID - The Conversation in which the Widget will be created.

gadgetID - The Gadget that this Widget will be an instance of.

type - The widgetType of Widget to create. May be null.

name - The name of the Widget.

enabled - True if the Widget should be created in an enabled state.

propertyInfos - Map of name/value pairs used by the Widget. May be null.

Returns:

The Info for the created Widget.

getWidget

XWidgetInfo getWidget(XObjectID widgetID)

Get Widget.

Parameters:

widgetID - The Widget.

Returns:

The Widget info.

setWidgetEnabled

XWidgetInfo setWidgetEnabled(XObjectID widgetID,
                             boolean enabled)

Set Widget enabled state.

Parameters:

widgetID - The Widget.

enabled - The enabled state.

Returns:

The updated Widget info.

updateWidgetSoon

void updateWidgetSoon(XObjectID widgetID)

Called by client to indicate widget should perform any automatic updates "soon".

Parameters:

widgetID - The Widget.

setWidgetName

XWidgetInfo setWidgetName(XObjectID widgetID,
                          String name)

Set Widget name.

Parameters:

widgetID - The Widget.

name - The name.

Returns:

The updated Widget info.

removeWidget

void removeWidget(XObjectID widgetID)

Remove a Widget.

Parameters:

widgetID - The Widget.

getEnabledWidgets

List<XWidgetInfo> getEnabledWidgets(XObjectID conversationID)

Get all the active Widgets for a given Conversation.

Parameters:

conversationID - The Conversation.

Returns:

List of Widget info.

getAllWidgets

List<XWidgetInfo> getAllWidgets(XObjectID conversationID)

Get all widgets for a given conversation, whether active or not.

Parameters:

conversationID - The conversation.

Returns:

List of Widget info.

createWidgetChat

XObjectID createWidgetChat(XObjectID widgetID,
                           String chatText)

Create a Widget related Chat message.

Parameters:

widgetID - The Widget.

chatText - The Chat text.

Returns:

The ID of the created Chat.

createWidgetComment

XObjectID createWidgetComment(XObjectID widgetID,
                              XObjectID chatID,
                              String chatText)

Create a Widget related Comment message.

Parameters:

widgetID - The Widget.

chatID - The existing Chat.

chatText - The Chat text.

Returns:

The ID of the created Comment.

Skip navigation links