Reference Guide Novell Vibe Cloud Wave Gadgets API Reference Guide

Transcription

1 Reference Guide Novell Vibe Cloud Wave Gadgets API Reference Guide

2 W a v e G a d g e t s A P I R e f e r e n c e Novell Vibe supports the Wave Gadgets API. This is the reference for the Wave Gadgets JavaScript API. n a m e s p a c e g a d g e t s This namespace is used by the Gadgets API for the features it offers in all containers, including Novell Vibe. They are documented in the Gadget API Developer's Guide JavaScript Reference. n a m e s p a c e g a d g e t s. w i n d o w This namespace is defined by the Gadgets API, and documented in the Gadgets API Reference ( The Wave Gadgets API adds an additional method on top of the set documented there. Return Value adjustwidth(opt_width:number=) Adjusts the gadget width n a m e s p a c e w a v e This namespace defines the top level wave object within the Wave Gadgets API. Return Value gethost() wave.participant Returns the Participant who added this gadget to the blip. Note that the host may no longer be in the participant list. getmode() wave.mode Returns the gadget wave.mode. getparticipantbyid(id:string) wave.participant Returns a Participant with the given id. getparticipants() Array. Returns a list of Participants on the message. getprivatestate() wave.state Returns the private gadget state as a wave.state object. getstate() wave.state Returns the gadget state as a wave.state object. gettime() number Retrieves the current time of the viewer. TODO: Define the necessary gadget <-> container communication and implement playback time. p. 2

3 getviewer() wave.participant Get the Participant whose client renders this gadget. getwaveid()?string Returns serialized message ID or null if not known. isinwavecontainer() boolean Indicates whether the gadget runs inside a Novell Vibe message container. isplayback() boolean Returns the playback state of the wave/wavelet/gadget. Note: For compatibility UNKNOWN mode identified as PLAYBACK. log(message:string) Requests the container to output a log message. setmodecallback(callback:f unction(wave.mode), opt_context?:object=) setparticipantcallback(cal lback:function(array.), opt_context?:object=) setprivatestatecallback(ca llback:function(wave.state = Object.=), opt_context:object=) Sets the mode change callback. Sets the participant update callback. If the participant information is already received, the callback is invoked immediately to report the current participant information. Only one callback can be defined. Consecutive calls would remove old callback and set the new one. Sets the private gadget state update callback. Works similarly to setstatecallback but handles the private state events. setsnippet(snippet:string) Requests the container to update the snippet visible in wave digest. p. 3

4 setstatecallback(callback: function(wave.state= Object.=), opt_context:object=) Sets the gadget state update callback. If the state is already received from the container, the callback is invoked immediately to report the current gadget state. Only invoke callback can be defined. Consecutive calls would remove the old callback and set the new one. c l a s s C a l l b a c k This class is an immutable utility class for handlings callbacks with variable arguments and an optional context. wave.callback(callback:?(function(wave.state= Object.=) function(array.=) function(wave.mode.=) ), opt_context:object=) Constructs a callback given the provided callback and an optional context. Methods Methods Return Value invoke(var_args:...) Invokes the callback method with any arguments passed. c l a s s M o d e Identifiers for wave modes exhibited by the blip containing the gadget. Constant Constant DIFF_ON_OPEN EDIT PLAYBACK The blip containing the gadget has changed since the last time it was opened and the gadget should notify this change to the user. Editing the gadget blip The blip containing the gadget is in playback mode. p. 4

5 UNKNOWN VIEW The blip containing the gadget is in an unknown mode. In this case, you should not attempt to edit the blip. The blip containing the gadget is in view, but not edit mode. c l a s s P a r t i c i p a n t This class specifies participants on a Novell Vibe message. wave.participant(id:string=,displayname:string=, thumbnailurl:string=) Creates a new participant. Methods Methods Return Value getdisplayname() string Gets the human-readable display name of this participant. getid() string Gets the unique identifier of this participant. getthumbnailurl() string Gets the url of the thumbnail image for this participant. c l a s s S t a t e This class contains state properties of the Gadget. wave.state(opt_rpc:string=) Creates a new state object to hold properties of the gadget. Methods Methods Return Value p. 5

6 get(key:string, opt_default:?string=)?string Retrieve a value from the synchronized state. As of now, get always returns a string. This will change at some point to return whatever was set. getkeys() Array. Retrieve the valid keys for the synchronized state. reset() Submits a delta to remove all keyvalues in the state. submitdelta(delta:!object.) Updates the state delta. This is an asynchronous call that will update the state and not take effect immediately. Creating any key with a null value will attempt to delete the key. submitvalue(key:string, value:? string) Submits delta that contains only one key-value pair. Note that if value is null the key will be removed from the state. See submitdelta(delta) for semantic details. tostring() string Pretty prints the current state object. Note this is a debug method only. n a m e s p a c e w a v e. u i This namespace defines methods for creating a Novell Vibe message look and feel inside a gadget. Return Value loadcss() Loads a CSS with Novell Vibe messagestyled-like styles into the gadget, including font properties, link properties, and the properties for the Novell Vibe message-styled button, dialog, and frame. p. 6

7 makebutton(target:element) Converts the passed in target into a Novell Vibe message-styled button. makedialog(target:element, title:string, onclick:) makeframe(target:ele ment) Converts the passed in target into a Novell Vibe message-styled dialog. For now it only creates a centered box. The close button in the upper right corner will be default do nothing. Converts the passed in target into a Novell Vibe message-styled frame. n a m e s p a c e w a v e. u t i l This namespace defines utility methods for use within the Wave Gadgets API. Return Value printjson(obj:object, opt_pretty:boolean=, opt_tabs:number=) string Outputs JSON objects in text format. Optionally pretty print. A t t r i b u t i o n Portions of this page are reproduced from work created and shared by Google and used according to terms described in the Creative Commons 3.0 Attribution License ( Refer to the Google Wave Gadgets API Reference ( for more information. Google 2010 p. 7