Class google.gdata.Link

Object
   |
   +--google.gdata.Link

Direct Known Subclasses:

google.gdata.calendar.CalendarLink, google.gdata.blogger.BloggerLink

class google.gdata.Link

Describes an external link type.
Defined in gdata.js

Field Detail

href

String|Undefined href

Link URI. This attribute is required.

hreflang

String|Undefined hreflang

Language of resource pointed to by href. This attribute is optional.

length

String|Undefined length

Length of the resource pointed to by href in bytes. This attribute is optional.

rel

String|Undefined rel

Link relation type. This attribute is optional.

title

String|Undefined title

Link title. This attribute is optional.

type

String|Undefined type

MIME type of link target. This attribute is optional.

REL_ACCESS_CONTROL_LIST

<static> <final> String REL_ACCESS_CONTROL_LIST

Link that provides the URI of the feed for the access control list for the entry.

REL_ALTERNATE

<static> <final> String REL_ALTERNATE

Link that provides the URI of an alternate format of the entry's or feed's contents. The type attribute of the link specifies a media type.

See Also:

Constant Field Values

REL_CONTROLLED_OBJECT

<static> <final> String REL_CONTROLLED_OBJECT

Link that provides the URI of the entry that is controlled by the access control list feed.

REL_ENTRY_EDIT

<static> <final> String REL_ENTRY_EDIT

Link that provides the URI that can be used to edit the entry. This relation does not exist if the entry is read-only.

See Also:

Constant Field Values

REL_ENTRY_POST

<static> <final> String REL_ENTRY_POST

Link that provides the URI that can be used to post new entries to the feed. This relation does not exist if the feed is read-only.

REL_FEED

<static> <final> String REL_FEED

Link that provides the URI of the full feed (without any query parameters).

REL_FEED_BATCH

<static> <final> String REL_FEED_BATCH

Link that provides the URI that can be used to insert, update and delete entries on this feed. This relation does not exist if the feed is read-only or if batching not enabled on this feed.

REL_MEDIA_EDIT

<static> <final> String REL_MEDIA_EDIT

Link that provides the URI that can be used to edit the media associated with an entry. This relation does not exist if there is no associated media or the media is read-only.

See Also:

Constant Field Values

REL_NEXT

<static> <final> String REL_NEXT

Link that provides the URI of next page in a paged feed.

See Also:

Constant Field Values

REL_PREVIOUS

<static> <final> String REL_PREVIOUS

Link that provides the URI of previous page in a paged feed.

See Also:

Constant Field Values

REL_RELATED

<static> <final> String REL_RELATED

Link that provides the URI of a related link to the entry.

See Also:

Constant Field Values

REL_SELF

<static> <final> String REL_SELF

Link that provides the URI of the feed or entry. If this relation appears on a feed that is the result of performing a query, then this URI includes the same query parameters (or at least querying this URI produces the same result as querying with those parameters).

See Also:

Constant Field Values

REL_VIA

<static> <final> String REL_VIA

Link that provides the URI that of link that provides the data for the content in the feed.

See Also:

Constant Field Values

google.gdata.Link

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.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: href, hrefLang, length, rel, title, titleLang, and type

getHref

String|Undefined getHref()

Returns the link URI. This attribute is required.

Returns:
Link URI or undefined for none

getHrefLang

String|Undefined getHrefLang()

Returns the language of resource pointed to by href. This attribute is optional.

Returns:
Language of resource pointed to by href or undefined for none

getLength

Number|Undefined getLength()

Returns the length of the resource pointed to by href in bytes. This attribute is optional.

Returns:
Length of the resource pointed to by href in bytes or undefined for none

getRel

String|Undefined getRel()

Returns the link relation type. This attribute is optional.

Returns:
Link relation type or undefined for none

getTitle

String|Undefined getTitle()

Returns the link title. This attribute is optional.

Returns:
Link title or undefined for none

getTitleLang

String|Undefined getTitleLang()

Returns the language of link title. This attribute is optional.

Returns:
Language of link title or undefined for none

getType

String|Undefined getType()

Returns the MIME type of link target. This attribute is optional.

Returns:
MIME type of link target or undefined for none

setHref

void setHref(<String|Undefined> href)

Sets the link URI. This attribute is required.

Parameters:
href - Link URI or undefined for none

setHrefLang

void setHrefLang(<String|Undefined> hrefLang)

Sets the language of resource pointed to by href. This attribute is optional.

Parameters:
hrefLang - Language of resource pointed to by href or undefined for none

setLength

void setLength(<Number|Undefined> length)

Sets the length of the resource pointed to by href in bytes. This attribute is optional.

Parameters:
length - Length of the resource pointed to by href in bytes or undefined for none

setRel

void setRel(<String|Undefined> rel)

Sets the link relation type. This attribute is optional.

Parameters:
rel - Link relation type or undefined for none

setTitle

void setTitle(<String|Undefined> title)

Sets the link title. This attribute is optional.

Parameters:
title - Link title or undefined for none

setTitleLang

void setTitleLang(<String|Undefined> titleLang)

Sets the language of link title. This attribute is optional.

Parameters:
titleLang - Language of link title or undefined for none

setType

void setType(<String|Undefined> type)

Sets the MIME type of link target. This attribute is optional.

Parameters:
type - MIME type of link target or undefined for none

create

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

Create a new link using the typical parameters.

Parameters:
rel - Link relation type
type - MIME type of the link target
href - Link URI
opt_title - Optional link title

Returns:
new link