Class google.gdata.atom.Link

Object
   |
   +--google.gdata.atom.Link

Direct Known Subclasses:

google.gdata.Link, google.gdata.threading.ThreadingLink

class google.gdata.atom.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_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_ENCLOSURE

<static> <final> {string} REL_ENCLOSURE

Link that identifies a resource related to the entry.

See Also:

Constant Field Values

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_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

TYPE_ATOM

<static> <final> {string} TYPE_ATOM

Link type used for Atom content.

See Also:

Constant Field Values

TYPE_HTML

<static> <final> {string} TYPE_HTML

Link type used for HTML content.

See Also:

Constant Field Values

google.gdata.atom.Link

google.gdata.atom.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.