|
GData JavaScript Client 2.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.client.Service
Atom service.
Defined in gdata.js
Field Summary | |
{string} |
applicationName
Application name. |
{string} |
serviceName
Service name. |
Constructor Summary | |
google.gdata.client.Service(<string> serviceName, <string> applicationName)
Creates a service that supports Atom only. |
Method Summary | |
void
|
deleteEntry(<string> uri, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <Object?> opt_params)
Deletes an entry. |
Object
|
getEntry(<string> uri, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_entryClass, <boolean?> opt_authenticationRequired, <Object?> opt_params)
Retrieves data of an entry. |
Object
|
getFeed( <string|google.gdata.client.Query> uriOrQuery, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_feedClass, <boolean?> opt_authenticationRequired, <Object?> opt_params)
Retrieves data of a feed. |
void
|
insertEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_entryClass)
Inserts a new entry. |
void
|
setDeveloperKey(<string> developerKey)
Sets developer key of this service. |
void
|
setHeaders(<Object> headers)
Sets headers that are to be sent on every request. |
void
|
updateEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_entryClass, <Object?> opt_params)
Updates an entry. |
Field Detail |
{string} applicationName
{string} serviceName
Constructor Detail |
google.gdata.client.Service(<string> serviceName, <string> applicationName)
serviceName
- Name of Atom service (used for tracking).
applicationName
- Name of application (used for tracking).
Method Detail |
void deleteEntry(<string> uri, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <Object?> opt_params)
uri
- The URI of the entry to delete.
continuation
- The function to call once the entry is deleted. Here's an example of a continuation function: function() { alert('entry deleted'); }
.
opt_errorHandler
- Optional function to handle errors. This function will receive an Error object as its input parameter. This Error object may have an extra 'cause' field with details about the http response in a google.gdata.client.TransportResponse object. This field only exists when the error was triggered by a non-200 http response. Here's an example of a error handler function: function(error) { var msg = error.message; if (error.cause) { // Grab the http response. msg = error.cause.getStatus() + ': ' + msg; } alert(msg); }
.
opt_params
- Optional parameters related to this request. Visit the JavaScript client documentation for more information on supported parameters: http://code.google.com/apis/gdata/client-js.html.
Object getEntry(<string> uri, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_entryClass, <boolean?> opt_authenticationRequired, <Object?> opt_params)
uri
- The URI of the entry to retrieve.
continuation
- The function to call once the entry is retrieved. This function will receive one input parameter: the entry object that was just retrieved. Here's an example of a continuation function: function(entryRoot) { // Grab the contents of the entry. var entry = entryRoot.entry; }
.
opt_errorHandler
- Optional function to handle errors. This function will receive an Error object as its input parameter. This Error object may have an extra 'cause' field with details about the http response in a google.gdata.client.TransportResponse object. This field only exists when the error was triggered by a non-200 http response. Here's an example of a error handler function: function(error) { var msg = error.message; if (error.cause) { // Grab the http response. msg = error.cause.getStatus() + ': ' + msg; } alert(msg); }
.
opt_entryClass
- Class constructor of entry to be returned.
opt_authenticationRequired
- Flag indicating whether authentication is required for this request.
opt_params
- Optional parameters related to this request. Visit the JavaScript client documentation for more information on supported parameters: http://code.google.com/apis/gdata/client-js.html.
Object getFeed( <string|google.gdata.client.Query> uriOrQuery, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_feedClass, <boolean?> opt_authenticationRequired, <Object?> opt_params)
uriOrQuery
- The URI of the feed to retrieve (as a string) or a query.
continuation
- The function to call once the feed is retrieved. This function will receive one input parameter: the feed object that was just retrieved. Here's an example of a continuation function: function(feedRoot) { // Grab the contents of the feed. var feed = feedRoot.feed; }
.
opt_errorHandler
- Optional function to handle errors. This function will receive an Error object as its input parameter. This Error object may have an extra 'cause' field with details about the http response in a google.gdata.client.TransportResponse object. This field only exists when the error was triggered by a non-200 http response. Here's an example of a error handler function: function(error) { var msg = error.message; if (error.cause) { // Grab the http response. msg = error.cause.getStatus() + ': ' + msg; } alert(msg); }
.
opt_feedClass
- Class constructor of feed to be returned.
opt_authenticationRequired
- Flag indicating whether authentication is required for this request.
opt_params
- Optional parameters related to this request. Visit the JavaScript client documentation for more information on supported parameters: http://code.google.com/apis/gdata/client-js.html.
void insertEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_entryClass)
uri
- The URI of the feed where the entry should be inserted.
entry
- The entry object to insert.
continuation
- The function to call once the entry is retrieved. This function will receive one input parameter: the entry object that was just retrieved. Here's an example of a continuation function: function(entryRoot) { // Grab the contents of the entry. var entry = entryRoot.entry; }
.
opt_errorHandler
- Optional function to handle errors. This function will receive an Error object as its input parameter. This Error object may have an extra 'cause' field with details about the http response in a google.gdata.client.TransportResponse object. This field only exists when the error was triggered by a non-200 http response. Here's an example of a error handler function: function(error) { var msg = error.message; if (error.cause) { // Grab the http response. msg = error.cause.getStatus() + ': ' + msg; } alert(msg); }
.
opt_entryClass
- Class constructor of entry to be returned.
void setDeveloperKey(<string> developerKey)
developerKey
- Service-specific developer key (not GData API developer key).
void setHeaders(<Object> headers)
headers
- Map of headers to send on every request.
void updateEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)?> opt_errorHandler, <function()?> opt_entryClass, <Object?> opt_params)
uri
- The URI of the entry to update.
entry
- The entry object to update.
continuation
- The function to call once the entry is updated. This function will receive one input parameter: the entry object that was just updated. Here's an example of a continuation function: function(entryRoot) { // Grab the contents of the entry. var entry = entryRoot.entry; }
.
opt_errorHandler
- Optional function to handle errors. This function will receive an Error object as its input parameter. This Error object may have an extra 'cause' field with details about the http response in a google.gdata.client.TransportResponse object. This field only exists when the error was triggered by a non-200 http response. Here's an example of a error handler function: function(error) { var msg = error.message; if (error.cause) { // Grab the http response. msg = error.cause.getStatus() + ': ' + msg; } alert(msg); }
.
opt_entryClass
- Class constructor of entry to be returned.
opt_params
- Optional parameters related to this request. Visit the JavaScript client documentation for more information on supported parameters: http://code.google.com/apis/gdata/client-js.html.
|
GData JavaScript Client 2.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |