Class google.gdata.client.Service

Object
   |
   +--google.gdata.client.Service

Direct Known Subclasses:

google.gdata.client.GoogleService

class google.gdata.client.Service

Atom service.
Defined in gdata.js

Field Detail

applicationName

{string} applicationName

Application name.

serviceName

{string} serviceName

Service name.

google.gdata.client.Service

google.gdata.client.Service(<string> serviceName, <string> applicationName)

Creates a service that supports Atom only.

Parameters:
serviceName - Name of Atom service (used for tracking).
applicationName - Name of application (used for tracking).

deleteEntry

void deleteEntry(<string> uri, <function(Object)> continuation, <function(Error)> opt_errorHandler)

Deletes an entry.

Parameters:
uri - URI of entry.
continuation - Function to call with entry deleted. 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); };.

getEntry

Object getEntry(<string> uri, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function|undefined> opt_entryClass, <boolean|undefined> opt_authenticationRequired)

Retrieves data of an entry.

Parameters:
uri - URI of entry.
continuation - Function to call with entry retrieved. 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);
  };

.
opt_entryClass - Class (constructor) of entry to be returned.
opt_authenticationRequired - Flag indicating whether authentication is required for this request.

getFeed

Object getFeed( <string|google.gdata.client.Query> uriOrQuery, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function|undefined> opt_feedClass, <boolean|undefined> opt_authenticationRequired)

Retrieves data of a feed.

Parameters:
uriOrQuery - URI of feed or query.
continuation - Function to call with feed retrieved. E.g.:


  function(feedRoot) {
    var feed = feedRoot.feed;
    var entries = feed.entry;
  };

.
opt_errorHandler - Function to handle error if any. E.g.:


  // error: an instance of Error
  function(error) {
    alert(error);
  };

.
opt_feedClass - Class (constructor) of feed to be returned.
opt_authenticationRequired - Flag indicating whether authentication is required for this request.

insertEntry

void insertEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function> opt_entryClass)

Inserts a new entry.

Parameters:
uri - URI of feed.
entry - Entry to insert.
continuation - Function to call with entry inserted. 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); };.
opt_entryClass - Class (constructor) of entry to be returned.

isXd2Supported

boolean isXd2Supported()

Tests whether XD2 transport is supported by this service. Non-Google services do not support it by default.

Returns:
Whether XD2 transport is supported.

setAltSupport

void setAltSupport(<string> alt, <boolean> supported)

Sets service's support for an alt format.

Parameters:
alt - alt format to set.
supported - true if the alt format is supported by this service; false otherwise.

setDeveloperKey

void setDeveloperKey(<string> developerKey)

Sets developer key of this service. Only necessary for Google Base where its own developer key is required.

Parameters:
developerKey - Service-specific developer key (not GData API developer key).

setHeaders

void setHeaders(<Object> headers)

Sets headers that are to be sent on every request.

Parameters:
headers - Map of headers to sent on every request.

setXd2Supported

void setXd2Supported(<boolean> xd2Supported)

Sets whether XD2 transport is supported by this service.

Parameters:
xd2Supported - Whether XD2 transport is supported.

supportsAlt

boolean supportsAlt(<string> alt)

Tests whether service supports an alt format.

Parameters:
alt - alt format to test.

Returns:
true if the alt format is supported by this service; false otherwise.

updateEntry

void updateEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function?> opt_entryClass)

Updates an entry.

Parameters:
uri - URI of entry.
entry - Entry to update.
continuation - Function to call with entry updated. 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); };.
opt_entryClass - Class (constructor) of entry to be returned.