Class google.gdata.Entry

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

Direct Known Subclasses:

google.gdata.finance.TransactionEntry, google.gdata.calendar.CalendarCommentEntry, google.gdata.finance.PositionEntry, google.gdata.calendar.CalendarEntry, google.gdata.contacts.ContactEntry, google.gdata.RecurrenceExceptionEntry, google.gdata.acl.AclEntry, google.gdata.contacts.ContactGroupEntry, google.gdata.blogger.CommentEntry, google.gdata.blogger.PostEntry, google.gdata.finance.PortfolioEntry, google.gdata.EventEntry, google.gdata.blogger.BlogEntry

class google.gdata.Entry

extends google.gdata.atom.Entry

Describes a Google Data API Entry.
Defined in gdata.js

Field Detail

$controlClass_

Object $controlClass_

google.gdata.Entry

google.gdata.Entry(<Object> opt_params)

Constructs a GData entry 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: authors, categories, content, contributors, control, edited, id, links, published, rights, summary, title, and updated

deleteEntry

Object deleteEntry(<function(Object)> continuation, <function(Error)> opt_errorHandler)

Deletes the entry from the feed.

Parameters:
continuation - Function to call on continuation. E.g.: function(entryRoot) { var entry = entryRoot.entry; };
opt_errorHandler - Function to handle error if any. E.g.: // error: an instance of Error function(error) { alert(error); };

getControl

google.gdata.app.Control|undefined getControl()

Returns the Atom publication control status. This element is optional.

Returns:
Atom publication control status or undefined for none

getEdited

google.gdata.app.Edited|undefined getEdited()

Returns the Atom entry last edited timestamp. This element is optional.

Returns:
Atom entry last edited timestamp or undefined for none

getEditLink

google.gdata.Link|Undefined getEditLink()

Returns the link that provides the URI that can be used to edit the entry.

Returns:
Link that provides the URI that can be used to edit the entry or undefined for none

getLink

google.gdata.Link|Undefined getLink(<String|Null> rel, <String> opt_type)

Returns the link of a relation and type.

Parameters:
rel - Link relation type to filter on or null to ignore
opt_type - Optional MIME type of the link target to filter on

Returns:
First link whose relation and type is a match or undefined for none

getSelf

google.gdata.Entry getSelf(<function(Object)> continuation, <function(Error)> opt_errorHandler)

Returns the current representation of the entry by requesting it from the associated service using the entry's self link.

Parameters:
continuation - Function to call on continuation. E.g.: function(entryRoot) { var entry = entryRoot.entry; };
opt_errorHandler - Function to handle error if any, e.g.: // error: an instance of Error function(error) { alert(error); };

Returns:
current representation of the entry

getSelfLink

google.gdata.Link|Undefined getSelfLink()

Returns the link that provides the URI of the feed or entry.

Returns:
Link that provides the URI of the feed or entry or undefined for none

setControl

void setControl(<google.gdata.app.Control|Object|undefined> control)

Sets the Atom publication control status. This element is optional.

Parameters:
control - Atom publication control status, or object to use as a parameter to the google.gdata.app.Control constructor, or undefined for none

setEdited

void setEdited(<google.gdata.app.Edited|Object|undefined> edited)

Sets the Atom entry last edited timestamp. This element is optional.

Parameters:
edited - Atom entry last edited timestamp, or object to use as a parameter to the google.gdata.app.Edited constructor, or undefined for none

updateEntry

google.gdata.Entry updateEntry(<function(Object)> continuation, <function(Error)> opt_errorHandler)

Updated the entry in the feed by sending the representation of this entry.

Parameters:
continuation - Function to call on continuation. E.g.: function(entryRoot) { var entry = entryRoot.entry; };
opt_errorHandler - Function to handle error if any, e.g.: // error: an instance of Error function(error) { alert(error); };

Returns:
the new representation of the entry returned from the service