Class google.gdata.client.GoogleService

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

Direct Known Subclasses:

google.gdata.gbase.GoogleBaseService, google.gdata.calendar.CalendarService, google.gdata.contacts.ContactsService, google.gdata.blogger.BloggerService, google.gdata.finance.FinanceService

class google.gdata.client.GoogleService

extends google.gdata.client.Service

GData Service.
Defined in gdata.js

Constructor Detail

google.gdata.client.GoogleService

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

Creates a service that supports all alt formats: 'atom', 'atom-in-script', 'json', 'json-in-script', 'rss' and 'rss-in-script'.

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

getUserCredentials

Object getUserCredentials()

Gets user credentials.

Returns:
User credentials with properties "username" and "password".

setGadgetsAuthentication

void setGadgetsAuthentication(<string> authType, <Object> opt_params)

Sets the authentication to be used when running inside a Shindig (OpenSocial) container. This must support Shindig version 0.8 or higher.

Parameters:
authType - one of the three valid Shindig authentication types: 'OAUTH', 'SIGNED' or 'NONE'.
opt_params - other parameters to pass through the request.

setUserCredentials

void setUserCredentials(<string?> username, <string?> password)

Sets user credentials. If either user name or password is not empty, also sets authentication required to be true. If authenticator is not ClientLogin, also sets it to ClientLogin.

Parameters:
username - User name.
password - Password.

useOAuth

void useOAuth(<string> opt_serviceName, <Object> opt_params)

Sets the authentication type to the OAuth Proxy.

Parameters:
opt_serviceName - The service whose credentials to use.
opt_params - Optional OAuth related parameters.