GData JavaScript Client 1.0

Class google.gdata.Link

Object
   |
   +--google.gdata.Link
Direct Known Subclasses:
google.gdata.calendar.CalendarLink

class google.gdata.Link


Describes an external link type.
Defined in gdata.js


Field Summary
 String|Undefined href
          Link URI.
 String|Undefined hreflang
          Language of resource pointed to by href.
 String|Undefined length
          Length of the resource pointed to by href in bytes.
 String|Undefined rel
          Link relation type.
 String|Undefined title
          Link title.
 String|Undefined type
          MIME type of link target.
<static>  <final> String REL_ACCESS_CONTROL_LIST
          Link that provides the URI of the feed for the access control list for the entry.
<static>  <final> String REL_ALTERNATE
          Link that provides the URI of an alternate format of the entry's or feed's contents.
<static>  <final> String REL_CONTROLLED_OBJECT
          Link that provides the URI of the entry that is controlled by the access control list feed.
<static>  <final> String REL_ENTRY_EDIT
          Link that provides the URI that can be used to edit the entry.
<static>  <final> String REL_ENTRY_POST
          Link that provides the URI that can be used to post new entries to the feed.
<static>  <final> String REL_FEED
          Link that provides the URI of the full feed (without any query parameters).
<static>  <final> String REL_FEED_BATCH
          Link that provides the URI that can be used to insert, update and delete entries on this feed.
<static>  <final> String REL_MEDIA_EDIT
          Link that provides the URI that can be used to edit the media associated with an entry.
<static>  <final> String REL_NEXT
          Link that provides the URI of next page in a paged feed.
<static>  <final> String REL_PREVIOUS
          Link that provides the URI of previous page in a paged feed.
<static>  <final> String REL_RELATED
          Link that provides the URI of a related link to the entry.
<static>  <final> String REL_SELF
          Link that provides the URI of the feed or entry.
<static>  <final> String REL_VIA
          Link that provides the URI that of link that provides the data for the content in the feed.
 
Constructor Summary
google.gdata.Link(<Object> opt_params)
            Constructs an external link using an object parameter whose property names match the setter method to use for each property.
 
Method Summary
 String|Undefined getHref()
           Returns the link URI.
 String|Undefined getHrefLang()
           Returns the language of resource pointed to by href.
 Number|Undefined getLength()
           Returns the length of the resource pointed to by href in bytes.
 String|Undefined getRel()
           Returns the link relation type.
 String|Undefined getTitle()
           Returns the link title.
 String|Undefined getTitleLang()
           Returns the language of link title.
 String|Undefined getType()
           Returns the MIME type of link target.
 void setHref(<String|Undefined> href)
           Sets the link URI.
 void setHrefLang(<String|Undefined> hrefLang)
           Sets the language of resource pointed to by href.
 void setLength(<Number|Undefined> length)
           Sets the length of the resource pointed to by href in bytes.
 void setRel(<String|Undefined> rel)
           Sets the link relation type.
 void setTitle(<String|Undefined> title)
           Sets the link title.
 void setTitleLang(<String|Undefined> titleLang)
           Sets the language of link title.
 void setType(<String|Undefined> type)
           Sets the MIME type of link target.
<static> google.gdata.Link create(<String> rel, <String> type, <String> href, <String> opt_title)
           Create a new link using the typical parameters.

Field Detail

href

String|Undefined href

hreflang

String|Undefined hreflang

length

String|Undefined length

rel

String|Undefined rel

title

String|Undefined title

type

String|Undefined type

REL_ACCESS_CONTROL_LIST

<static> <final> String REL_ACCESS_CONTROL_LIST

REL_ALTERNATE

<static> <final> String REL_ALTERNATE

REL_CONTROLLED_OBJECT

<static> <final> String REL_CONTROLLED_OBJECT

REL_ENTRY_EDIT

<static> <final> String REL_ENTRY_EDIT

REL_ENTRY_POST

<static> <final> String REL_ENTRY_POST

REL_FEED

<static> <final> String REL_FEED

REL_FEED_BATCH

<static> <final> String REL_FEED_BATCH

REL_MEDIA_EDIT

<static> <final> String REL_MEDIA_EDIT

REL_NEXT

<static> <final> String REL_NEXT

REL_PREVIOUS

<static> <final> String REL_PREVIOUS

REL_RELATED

<static> <final> String REL_RELATED

REL_SELF

<static> <final> String REL_SELF

REL_VIA

<static> <final> String REL_VIA

Constructor Detail

google.gdata.Link

google.gdata.Link(<Object> opt_params)

Method Detail

getHref

String|Undefined getHref()

getHrefLang

String|Undefined getHrefLang()

getLength

Number|Undefined getLength()

getRel

String|Undefined getRel()

getTitle

String|Undefined getTitle()

getTitleLang

String|Undefined getTitleLang()

getType

String|Undefined getType()

setHref

void setHref(<String|Undefined> href)

setHrefLang

void setHrefLang(<String|Undefined> hrefLang)

setLength

void setLength(<Number|Undefined> length)

setRel

void setRel(<String|Undefined> rel)

setTitle

void setTitle(<String|Undefined> title)

setTitleLang

void setTitleLang(<String|Undefined> titleLang)

setType

void setType(<String|Undefined> type)

create

<static> google.gdata.Link create(<String> rel, <String> type, <String> href, <String> opt_title)

GData JavaScript Client 1.0

Documentation generated by JSDoc on Fri Sep 14 16:32:36 2007