|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface XWidgetModule.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 |
---|
XWidgetInfo createWidget(XObjectID conversationID, XObjectID gadgetID, String type, String name, boolean enabled, List<XPropertyInfo> propertyInfos)
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.XWidgetInfo getWidget(XObjectID widgetID)
widgetID
- The Widget.XWidgetInfo setWidgetEnabled(XObjectID widgetID, boolean enabled)
widgetID
- The Widget.enabled
- The enabled state.void updateWidgetSoon(XObjectID widgetID)
widgetID
- The Widget.XWidgetInfo setWidgetName(XObjectID widgetID, String name)
widgetID
- The Widget.name
- The name.void removeWidget(XObjectID widgetID)
widgetID
- The Widget.List<XWidgetInfo> getEnabledWidgets(XObjectID conversationID)
conversationID
- The Conversation.List<XWidgetInfo> getAllWidgets(XObjectID conversationID)
conversationID
- The conversation.XObjectID createWidgetChat(XObjectID widgetID, String chatText)
widgetID
- The Widget.chatText
- The Chat text.XObjectID createWidgetComment(XObjectID widgetID, XObjectID chatID, String chatText)
widgetID
- The Widget.chatID
- The existing Chat.chatText
- The Chat text.
|
Oracle® On Track Communication SDK Documentation Release 1(1.0) E20955-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |