| | Sign in

Google Wave API (Labs)

Wave API Overview

Extensions Overview
Extension Design Principles

Robots API
- Overview
- Java Client Library
- Python Client Library
Gadgets API
- Tutorial
- Reference
Extension Installers
- Guide

Wave Embed API
- Tutorial
- Reference

Wave Resources

Google Wave Embed API Reference

class OpenSocialWave

This class defines the container to hold an OpenSocial-embedded wave panel

Constructor

Constructor	Description
`OpenSocialWave()`	Constructs the OpenSocial-embedded wave panel. Note that this constructor does not initialize the wave panel. To do so, call `init()`.

Methods

Methods	Return Value	Description
`init()`	`None`	Initializes the embedded wave panel by loading the OpenSocial friends list as contacts and getting an authentication token from Wave. When done, this method will populate the associated wave panel with the client wave.

class WavePanel

This class defines an object to hold the embedded wave, in which an <iframe> is constructed.

Constructor

Constructor	Description
`WavePanel(opt_rootUrl?:String)`	Constructs a `WavePanel` in the passed container. An `<iframe>` is created inside the supplied container; if the container is null, the `<iframe>` is instead appended to the current document. The created object can be used to interact with the panel and indirectly with any displayed wave.

Methods

Methods	Return Value	Description
`addListener(eventType:String, handlerFunction:Function)`	`None`	Adds an event listener.
`addParticipant()`	`None`	Adds the current user as a participant to the wave.
`addReply(participantId:String, opt_callback:Function)`	`None`	Adds a reply to the currently loaded wave. An empty reply will be added to the wave for the user specified. If `participantId` is empty, an attempt is made to authenticate the user against Google. If that fails, a url is provided in the `callback` to which the client should be redirected to provide for the login.
`getFrameId()`	`String`	Returns the frame ID.
`init(container:Object, opt_loadCallback:Function)`	`None`	Actually creates the wave `<iframe>` inside the given container. This creation is not done in the constructor to allow the caller to set various initialization options.
`loadSearch(searchExpr:String, opt_callback:Function)`	`None`	Loads a new search expression into the digest. This can be called before or after `init`.
`loadWave(waveId:String, opt_callback:Function)`	`None`	Loads a new wave into the `WavePanel`. This method can be called before or after `init`.
`provideProfiles(profiles:Object)`	`None`	Provides information about profiles. This method is used to return values from the profile provider. The expected input format is a map of wave addresses to objects with the following fields: firstName lastName photoUrl
`setAuthToken(token:String)`	`None`	Sets the authentication token. This token must have been obtained by a signed request to wave.
`setContactProvider(providerFunc:Function)`	`None`	Sets the function which can be called to provide profile information. This method is used when users need to be displayed but their information is not yet available.
`setContacts(contacts:Array.)`	`None`	Sets the IDs of the contacts that will be displayed in the contact picker. Fetching their profiles is independent from this.
`setEditMode(value:)`	`None`	Sets the edit mode for the wave. This method currently affects only the root blip.
`setToolbarVisible(value:)`	`None`	Sets the visibility of the panel switch toolbar.
`setUIConfig(bgcolor:String, color:String, font:String, fontsize:String)`	`None`	Set the UI configuration for the wave. This must be done before `init()` is called. Note that `fontSize` must be expressed in points, such as `"12pt"`, or in pixels, such as `"12px"`. Other CSS properties are not fully supported. This can only be done before init.
`setUIConfigObject(config:WavePanel.UIConfig)`	`None`	Set the UI configuration for the wave. This can only be done before `init()`.

class UIConfig

This class holds configuration parameters for the WavePanel.

Constructor

Constructor	Description
`WavePanel.UIConfig()`	Constructs a `WavePanel.UIConfig`. This constructor takes no arguments; instead, it creates a UI configuration with default parameters.

Methods

Methods	Return Value	Description
`getBgcolor()`	`String`	Returns the background color
`getColor()`	`String`	Returns the font color
`getFont()`	`String`	Returns the font
`getFontSize()`	`String`	Returns the font size
`getFooterEnabled()`	`Boolean`	Returns whether the footer is enabled
`getHeaderEnabled()`	`Boolean`	Returns whether the header is neabled
`getToolbarEnabled()`	`Boolean`	Returns whether the toolbar is enabled
`setBgcolor(color:String)`	`None`	Sets the background color
`setColor(color:String)`	`None`	Sets the font color
`setFont(font:String)`	`None`	Sets the font
`setFontSize(fontsize:String)`	`None`	Sets the font size
`setFooterEnabled(enabled:Boolean)`	`None`	Sets the state indicating whether the footer is enabled
`setHeaderEnabled(enabled:Boolean)`	`None`	Sets the state indicating whether the header is enabled
`setToolbarEnabled(enabled:Boolean)`	`None`	Sets the state indicating whether the toolbar is enabled