|
GData JavaScript Client 1.8 | ||||||||
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)
Deletes an entry. |
Object
|
getEntry(<string> uri, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function|undefined> opt_entryClass, <boolean|undefined> opt_authenticationRequired)
Retrieves data of an entry. |
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. |
void
|
insertEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function> opt_entryClass)
Inserts a new entry. |
boolean
|
isXd2Supported()
Tests whether XD2 transport is supported by this service. |
void
|
setAltSupport(<string> alt, <boolean> supported)
Sets service's support for an alt format. |
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
|
setXd2Supported(<boolean> xd2Supported)
Sets whether XD2 transport is supported by this service. |
boolean
|
supportsAlt(<string> alt)
Tests whether service supports an alt format. |
void
|
updateEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function?> opt_entryClass)
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)
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); };.
Object getEntry(<string> uri, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function|undefined> opt_entryClass, <boolean|undefined> opt_authenticationRequired)
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.
Object getFeed( <string|google.gdata.client.Query> uriOrQuery, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function|undefined> opt_feedClass, <boolean|undefined> opt_authenticationRequired)
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.
void insertEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function> opt_entryClass)
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.
boolean isXd2Supported()
void setAltSupport(<string> alt, <boolean> supported)
alt
- alt format to set.
supported
- true if the alt format is supported by this service; false otherwise.
void setDeveloperKey(<string> developerKey)
developerKey
- Service-specific developer key (not GData API developer key).
void setHeaders(<Object> headers)
headers
- Map of headers to sent on every request.
void setXd2Supported(<boolean> xd2Supported)
xd2Supported
- Whether XD2 transport is supported.
boolean supportsAlt(<string> alt)
alt
- alt format to test.
void updateEntry( <string> uri, <Object> entry, <function(Object)> continuation, <function(Error)> opt_errorHandler, <Function?> opt_entryClass)
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.
|
GData JavaScript Client 1.8 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |