API Documentation

Gdata/ClientLogin.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gdata
version
$Id: ClientLogin.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_ClientLogin

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Gdata_ClientLogin

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
see
http://code.google.com/apis/accounts/AuthForInstalledApps.html
subpackage
Gdata
Constants
CLIENTLOGIN_URI
DEFAULT_SOURCE
Methods
getHttpClient

Description

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

Constants

CLIENTLOGIN_URI

 CLIENTLOGIN_URI = 'https://www.google.com/accounts/ClientLogin'

The Google client login URI

Details

value
https://www.google.com/accounts/ClientLogin

DEFAULT_SOURCE

 DEFAULT_SOURCE = 'Zend-ZendFramework'

The default 'source' parameter to send to Google

Details

value
Zend-ZendFramework

Methods

getHttpClient

getHttpClient( string $email, string $password, string $service = xapi, Zend_Gdata_HttpClient $client = null, string $source = self, string $loginToken = null, string $loginCaptcha = null,  $loginUri = self, string $accountType = HOSTED_OR_GOOGLE ) : Zend_Gdata_HttpClient

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.

Arguments
$email
string
$password
string
$service
string
$client
Zend_Gdata_HttpClient
$source
string
$loginToken
string
The token identifier as provided by the server.
$loginCaptcha
string
The user's response to the CAPTCHA challenge.
$loginUri
$accountType
string
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
Details
visibility
public
final
false
static
true
throws
throws
throws
Documentation was generated by DocBlox.