## Zend_Gdata_ClientLogin

Description

Class to facilitate Google's "Account Authentication for Installed Applications" also known as "ClientLogin".

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- see: http://code.google.com/apis/accounts/AuthForInstalledApps.html
- license: New BSD License

Located in /Gdata/ClientLogin.php (line 45)

Class Constant Summary
CLIENTLOGIN_URI = 'https://www.google.com/accounts/ClientLogin'
DEFAULT_SOURCE = 'Zend-ZendFramework'
Method Summary
static Zend_Gdata_HttpClient getHttpClient (string $email, string $password, [string $service = 'xapi'], [Zend_Gdata_HttpClient $client = null], [string $source = self::DEFAULT_SOURCE], [string $loginToken = null], [string $loginCaptcha = null], [ $loginUri = self::CLIENTLOGIN_URI], [string $accountType = 'HOSTED_OR_GOOGLE'])
Methods
static getHttpClient (line 81)

Set Google authentication credentials.

Must be done before trying to do any Google Data operations that require authentication. For example, viewing private data, or posting or deleting entries.

- throws: Zend_Gdata_App_CaptchaRequiredException
- throws: Zend_Gdata_App_AuthException
- throws: Zend_Gdata_App_HttpException
- access: public

static Zend_Gdata_HttpClient getHttpClient (string $email, string $password, [string $service = 'xapi'], [Zend_Gdata_HttpClient $client = null], [string $source = self::DEFAULT_SOURCE], [string $loginToken = null], [string $loginCaptcha = null], [ $loginUri = self::CLIENTLOGIN_URI], [string $accountType = 'HOSTED_OR_GOOGLE'])

- string $email
- string $password
- string $service
- Zend_Gdata_HttpClient $client
- string $source
- string $loginToken: The token identifier as provided by the server.
- string $loginCaptcha: The user's response to the CAPTCHA challenge.
- string $accountType: An optional string to identify whether the account to be authenticated is a google or a hosted account. Defaults to 'HOSTED_OR_GOOGLE'. See: http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Request
- $loginUri

Class Constants
CLIENTLOGIN_URI = 'https://www.google.com/accounts/ClientLogin' (line 52)

The Google client login URI

DEFAULT_SOURCE = 'Zend-ZendFramework' (line 58)

The default 'source' parameter to send to Google

Documentation generated on Tue, 26 Oct 2010 20:08:28 +0400 by phpDocumentor 1.4.2