GData JavaScript Client 2.1

Class google.accounts.user

Object
   |
   +--google.accounts.user

class google.accounts.user


Class representing state of an authenticated user session.
Defined in gdata.js


Constructor Summary
google.accounts.user()
           
 
Method Summary
 string|undefined checkLogin(<string> scope)
           Checks whether a cookie containing a token for the specified scope exists.
 boolean getInfo(<Function> callback, <string> opt_scope)
           Gets detailed information related to the current token, including target (the domain that originally requested the token) and scope.
 Array.<string> getScopes()
           Returns an array of the scopes the user is currently logged into.
 google.accounts.AuthSubStatus getStatus(<string> opt_scope)
           Returns the current status of the AuthSubJS process, which can be one of the following three status codes:
  • google.accounts.AuthSubStatus.LOGGED_OUT - The user is logged out.
  • google.accounts.AuthSubStatus.LOGGING_IN - The user is in the process of logging in with AuthSubJS.
  • google.accounts.AuthSubStatus.LOGGED_IN - The user is logged in.
If an optional scope argument is passed in, the method will return the status for that scope only.
 string? login(<string> scope, <Object> opt_params)
           Retrieves a valid authentication token.
 boolean logout(<Function> opt_callback, <string> opt_scope)
           Revokes all authentication tokens for all scopes (unless a particular scope is specified as an argument or to checkLogin() and deletes all authentication cookies stored by the browser.

Constructor Detail

google.accounts.user

google.accounts.user()

Method Detail

checkLogin

string|undefined checkLogin(<string> scope)

getInfo

boolean getInfo(<Function> callback, <string> opt_scope)

getScopes

Array.<string> getScopes()

getStatus

google.accounts.AuthSubStatus getStatus(<string> opt_scope)

login

string? login(<string> scope, <Object> opt_params)

logout

boolean logout(<Function> opt_callback, <string> opt_scope)

GData JavaScript Client 2.1

Documentation generated by JSDoc on Mon Nov 9 14:24:07 2009