Class google.gdata.calendar.WebContent

Object
   |
   +--google.gdata.calendar.WebContent

class google.gdata.calendar.WebContent

Describes a "web content" extension. For example: <atom:link rel="http://schemas.google.com/gCal/2005/webContent" title="World Cup" href="http://www.google.com/calendar/images/google-holiday.gif" type="image/gif"> <gCal:webContent width="276" height="120" url="http://www.google.com/logos/worldcup06.gif"/> </atom:link>
Defined in gdata.js

Field Detail

$gadgetPrefsClass_

Object $gadgetPrefsClass_

height

{string|undefined} height

Height (in pixels) of the <iframe> or <img> element. This attribute is required.

url

{string|undefined} url

URL of the content to display in the pop-up window. This attribute is required.

width

{string|undefined} width

Width (in pixels) of the <iframe> or <img> element. This attribute is required.

google.gdata.calendar.WebContent

google.gdata.calendar.WebContent(<Object> opt_params)

Constructs a web content using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: gadgetPrefs, height, url, and width.

addGadgetPref

void addGadgetPref(<google.gdata.calendar.WebContentGadgetPref|Object> gadgetPref)

Adds a new web content gadget preference.

Parameters:
gadgetPref - Web content gadget preference to add, or object to use as a parameter to the google.gdata.calendar.WebContentGadgetPref constructor.

getGadgetPref

google.gdata.calendar.WebContentGadgetPref|Undefined getGadgetPref(<string> name)

Returns the web content gadget preference of a given name.

Parameters:
name - Preference name.

Returns:
First web content gadget preference whose name is a match or undefined for none.

getGadgetPrefs

Array.<google.gdata.calendar.WebContentGadgetPref> getGadgetPrefs()

Returns the web content gadget preferences.

Returns:
Web content gadget preferences.

getHeight

number|undefined getHeight()

Returns the height (in pixels) of the <iframe> or <img> element. This attribute is required.

Returns:
Height (in pixels) of the <iframe> or <img> element or undefined for none.

getUrl

string|undefined getUrl()

Returns the URL of the content to display in the pop-up window. This attribute is required.

Returns:
URL of the content to display in the pop-up window or undefined for none.

getWidth

number|undefined getWidth()

Returns the width (in pixels) of the <iframe> or <img> element. This attribute is required.

Returns:
Width (in pixels) of the <iframe> or <img> element or undefined for none.

setGadgetPrefs

void setGadgetPrefs(<Array.<google.gdata.calendar.WebContentGadgetPref>|Array.<Object>|undefined> gadgetPrefs)

Sets the web content gadget preferences.

Parameters:
gadgetPrefs - Web content gadget preferences, where each web content gadget preference is added using the addGadgetPref() function, or undefined to clear the web content gadget preferences.

setHeight

void setHeight(<number|undefined> height)

Sets the height (in pixels) of the <iframe> or <img> element. This attribute is required.

Parameters:
height - Height (in pixels) of the <iframe> or <img> element or undefined for none.

setUrl

void setUrl(<string|undefined> url)

Sets the URL of the content to display in the pop-up window. This attribute is required.

Parameters:
url - URL of the content to display in the pop-up window or undefined for none.

setWidth

void setWidth(<number|undefined> width)

Sets the width (in pixels) of the <iframe> or <img> element. This attribute is required.

Parameters:
width - Width (in pixels) of the <iframe> or <img> element or undefined for none.