diff options
Diffstat (limited to 'zend/documentation/api/core/files/Gdata.Gapps.html')
| -rw-r--r-- | zend/documentation/api/core/files/Gdata.Gapps.html | 475 |
1 files changed, 475 insertions, 0 deletions
diff --git a/zend/documentation/api/core/files/Gdata.Gapps.html b/zend/documentation/api/core/files/Gdata.Gapps.html new file mode 100644 index 0000000..3c3b6c2 --- /dev/null +++ b/zend/documentation/api/core/files/Gdata.Gapps.html @@ -0,0 +1,475 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Gdata API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link><script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../js/jquery.tools.min.js"></script><script type="text/javascript" src="../js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../js/template.js"></script></head><body><div id="content"><h1 class="file">Gdata/Gapps.php</h1><div id="file-nav-box"><div id="file-nav-options"> + Show: + <img src="../images/icons/visibility_public.png" alt="Public" id="show-public"></img><img src="../images/icons/visibility_protected.png" alt="Protected" id="show-protected"></img><img src="../images/icons/visibility_private.png" alt="Private" id="show-private"></img><span class="attribute" id="show-inherited">inherited</span></div><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img> + Classes + </a><ul><li><a href="#\Zend_Gdata_Gapps">\Zend_Gdata_Gapps</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab"> + Table of Contents + </div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">Zend Framework</div><div class="long-description"><p>LICENSE</p> + +<p>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.</p></div></div><dl class="file-info"><dt>Category</dt><dd>Zend + + </dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + + </dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a> + + </dd><dt>Package</dt><dd>Zend_Gdata + + </dd><dt>Subpackage</dt><dd>Gapps + + </dd><dt>Version</dt><dd>$Id: Gapps.php 24593 2012-01-05 20:35:02Z matthew $ + + </dd></dl><a name="classes" class="anchor"></a><a id="\Zend_Gdata_Gapps" class="anchor"></a><h2 class="class">\Zend_Gdata_Gapps<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>Zend\Gdata\Gapps</small><div class="short-description">Service class for interacting with the Google Apps Provisioning API.</div><div class="long-description"><p>Like other service classes in this module, this class provides access via +an HTTP client to Google servers for working with entries and feeds.</p> + +<p>Because of the nature of this API, all access must occur over an +authenticated connection.</p></div><dl class="class-info"><dt>Parent(s)</dt><dd><a href="../files/Gdata.html#\Zend_Gdata">\Zend_Gdata</a> + < + <a href="../files/Gdata.App.html#\Zend_Gdata_App" style="color: gray; font-size: 0.8em + ">\Zend_Gdata_App</a></dd><dt>Category</dt><dd>Zend + + </dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) + + </dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a> + + </dd><dt>Link</dt><dd><a href="http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html">http://code.google.com/apis/apps/gdata_provisioning_api_v2.0_reference.html</a> + + </dd></dl><h3>Constants</h3><div><a id="\Zend_Gdata_Gapps::APPS_BASE_FEED_URI" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">APPS_BASE_FEED_URI</span> + = 'https://apps-apis.google.com/a/feeds'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::AUTH_SERVICE_NAME" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img>string + <span class="highlight">AUTH_SERVICE_NAME</span> + = 'apps'</code><div class="description"><div class="short-description">Service name for use with Google's authentication mechanisms</div></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt></dt><dd>string<br></br><em></em></dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::APPS_USER_PATH" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">APPS_USER_PATH</span> + = '/user/2.0'</code><div class="description"><div class="short-description">Path to user feeds on the Google Apps server.</div></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::APPS_NICKNAME_PATH" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">APPS_NICKNAME_PATH</span> + = '/nickname/2.0'</code><div class="description"><div class="short-description">Path to nickname feeds on the Google Apps server.</div></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::APPS_GROUP_PATH" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">APPS_GROUP_PATH</span> + = '/group/2.0'</code><div class="description"><div class="short-description">Path to group feeds on the Google Apps server.</div></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::APPS_EMAIL_LIST_PATH" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">APPS_EMAIL_LIST_PATH</span> + = '/emailList/2.0'</code><div class="description"><div class="short-description">Path to email list feeds on the Google Apps server.</div></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::APPS_EMAIL_LIST_RECIPIENT_POSTFIX" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">APPS_EMAIL_LIST_RECIPIENT_POSTFIX</span> + = '/recipient'</code><div class="description"><div class="short-description">Path to email list recipient feeds on the Google Apps server.</div></div><div class="code-tabs"><div class="long-description"></div></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::DEFAULT_MAJOR_PROTOCOL_VERSION" class="anchor"></a><div class="constant publicC inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">DEFAULT_MAJOR_PROTOCOL_VERSION</span> + = 1</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Default major protocol version.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION</a><a href="../files/Gdata.html#\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION</a></small></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION</a> + + </dd><dt>See</dt><dd>\_majorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::DEFAULT_MINOR_PROTOCOL_VERSION" class="anchor"></a><div class="constant publicC inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> + <span class="highlight">DEFAULT_MINOR_PROTOCOL_VERSION</span> + = null</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Default minor protocol version.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION</a><a href="../files/Gdata.html#\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION</a></small></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION</a> + + </dd><dt>See</dt><dd>\_minorProtocolVersion + + </dd></dl></div><div class="clear"></div></div></div><h3>Properties</h3><div><a id="\Zend_Gdata_Gapps::$_defaultPostUri" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>string <span class="highlight">$_defaultPostUri</span> = null</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Default URI to which to POST.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$_defaultPostUri">\Zend_Gdata::$$_defaultPostUri</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_defaultPostUri">\Zend_Gdata::$$_defaultPostUri</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_domain" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>string <span class="highlight">$_domain</span> = null</code><div class="description"><div class="short-description">The domain which is being administered via the Provisioning API.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_gzipEnabled" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_gzipEnabled</span> = false</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Enable gzipped responses?</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_gzipEnabled">\Zend_Gdata_App::$$_gzipEnabled</a><a href="../files/Gdata.html#\Zend_Gdata::$$_gzipEnabled">\Zend_Gdata::$$_gzipEnabled</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_gzipEnabled">\Zend_Gdata_App::$$_gzipEnabled</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_gzipEnabled">\Zend_Gdata::$$_gzipEnabled</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_httpClient" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>\Zend_Gdata_HttpClient <span class="highlight">$_httpClient</span></code><div class="description"><span class="attribute">inherited</span><div class="short-description">Client object used to communicate</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$_httpClient">\Zend_Gdata::$$_httpClient</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a></dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_httpClient">\Zend_Gdata::$$_httpClient</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_httpMethodOverride" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_httpMethodOverride</span> = false</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Override HTTP PUT and DELETE request methods?</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_httpMethodOverride">\Zend_Gdata_App::$$_httpMethodOverride</a><a href="../files/Gdata.html#\Zend_Gdata::$$_httpMethodOverride">\Zend_Gdata::$$_httpMethodOverride</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_httpMethodOverride">\Zend_Gdata_App::$$_httpMethodOverride</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_httpMethodOverride">\Zend_Gdata::$$_httpMethodOverride</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_majorProtocolVersion" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">$_majorProtocolVersion</span></code><div class="description"><span class="attribute">inherited</span><div class="short-description">Indicates the major protocol version that should be used.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_majorProtocolVersion">\Zend_Gdata_App::$$_majorProtocolVersion</a><a href="../files/Gdata.html#\Zend_Gdata::$$_majorProtocolVersion">\Zend_Gdata::$$_majorProtocolVersion</a></small></div><div class="code-tabs"><div class="long-description"><p>At present, recognized values are either 1 or 2. However, any integer +value >= 1 is considered valid.</p> + +<p>Under most circumtances, this will be automatically set by +Zend_Gdata_App subclasses.</p></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_majorProtocolVersion">\Zend_Gdata_App::$$_majorProtocolVersion</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_majorProtocolVersion">\Zend_Gdata::$$_majorProtocolVersion</a> + + </dd><dt>See</dt><dd>\setMajorProtocolVersion() + + </dd><dt>See</dt><dd>\getMajorProtocolVersion() + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_maxRedirects" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>int <span class="highlight">$_maxRedirects</span> = 5</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Maximum number of redirects to follow during HTTP operations</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_maxRedirects">\Zend_Gdata_App::$$_maxRedirects</a><a href="../files/Gdata.html#\Zend_Gdata::$$_maxRedirects">\Zend_Gdata::$$_maxRedirects</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>5</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>int</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_maxRedirects">\Zend_Gdata_App::$$_maxRedirects</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_maxRedirects">\Zend_Gdata::$$_maxRedirects</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_minorProtocolVersion" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">$_minorProtocolVersion</span></code><div class="description"><span class="attribute">inherited</span><div class="short-description">Indicates the minor protocol version that should be used.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_minorProtocolVersion">\Zend_Gdata_App::$$_minorProtocolVersion</a><a href="../files/Gdata.html#\Zend_Gdata::$$_minorProtocolVersion">\Zend_Gdata::$$_minorProtocolVersion</a></small></div><div class="code-tabs"><div class="long-description"><p>Can be set +to either an integer >= 0, or NULL if no minor version should be sent +to the server.</p> + +<p>At present, this field is not used by any Google services, but may be +used in the future.</p> + +<p>Under most circumtances, this will be automatically set by +Zend_Gdata_App subclasses.</p></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_minorProtocolVersion">\Zend_Gdata_App::$$_minorProtocolVersion</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_minorProtocolVersion">\Zend_Gdata::$$_minorProtocolVersion</a> + + </dd><dt>See</dt><dd>\setMinorProtocolVersion() + + </dd><dt>See</dt><dd>\getMinorProtocolVersion() + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_registeredPackages" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>array <span class="highlight">$_registeredPackages</span> = array('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Packages to search for classes when using magic __call method, in order.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$_registeredPackages">\Zend_Gdata::$$_registeredPackages</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>array('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_registeredPackages">\Zend_Gdata::$$_registeredPackages</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_staticHttpClient" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>\Zend_Gdata_HttpClient <span class="highlight">$_staticHttpClient</span> = null</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Client object used to communicate in static context</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$_staticHttpClient">\Zend_Gdata::$$_staticHttpClient</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a></dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_staticHttpClient">\Zend_Gdata::$$_staticHttpClient</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_useObjectMapping" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_useObjectMapping</span> = true</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Whether we want to use XML to object mapping when fetching data.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_useObjectMapping">\Zend_Gdata_App::$$_useObjectMapping</a><a href="../files/Gdata.html#\Zend_Gdata::$$_useObjectMapping">\Zend_Gdata::$$_useObjectMapping</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>true</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_useObjectMapping">\Zend_Gdata_App::$$_useObjectMapping</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_useObjectMapping">\Zend_Gdata::$$_useObjectMapping</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$_verboseExceptionMessages" class="anchor"></a><div class="property protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_verboseExceptionMessages</span> = true</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Use verbose exception messages.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_verboseExceptionMessages">\Zend_Gdata_App::$$_verboseExceptionMessages</a><a href="../files/Gdata.html#\Zend_Gdata::$$_verboseExceptionMessages">\Zend_Gdata::$$_verboseExceptionMessages</a></small></div><div class="code-tabs"><div class="long-description"><p>In the case of HTTP errors, +use the body of the HTTP response in the exception message.</p></div><strong>Default value</strong><code>true</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_verboseExceptionMessages">\Zend_Gdata_App::$$_verboseExceptionMessages</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_verboseExceptionMessages">\Zend_Gdata::$$_verboseExceptionMessages</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::$namespaces" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>array <span class="highlight">$namespaces</span> = array(array('apps', 'http://schemas.google.com/apps/2006', 1, 0))</code><div class="description"><span class="attribute">static</span><div class="short-description">Namespaces used for Zend_Gdata_Gapps</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>array(array('apps', 'http://schemas.google.com/apps/2006', 1, 0))</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Zend_Gdata_Gapps::__call()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__call</span><span class="nb-faded-text">(string $method, array $args)</span> : void</code><div class="description"><p class="short_description">Provides a magic factory method to instantiate new objects with +shorter syntax than would otherwise be required by the Zend Framework +naming conventions.</p></div><div class="code-tabs"><div class="long-description"><p>For more information, see Zend_Gdata_App::__call().</p> + +<p>This overrides the default behavior of __call() so that query classes +do not need to have their domain manually set when created with +a magic factory method.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$method</th><td>string</td><td><em><p>The method name being called</p></em></td></tr><tr><th>$args</th><td>array</td><td><em><p>The arguments passed to the call</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::__call()">\Zend_Gdata_App::__call()</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">(<a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $client = null, string $domain = null, string $applicationId = 'MyCompany-MyApp-1.0')</span> : void</code><div class="description"><p class="short_description">Create Gdata_Gapps object</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$client</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em><p>(optional) The HTTP client to use when + when communicating with the Google Apps servers.</p> +</em></td></tr><tr><th>$domain</th><td>string</td><td><em><p>(optional) The Google Apps domain which is to be + accessed.</p> +</em></td></tr><tr><th>$applicationId</th><td>string</td><td><em><p>The identity of the app in the form of Company-AppName-Version</p> +</em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::addMemberToGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">addMemberToGroup</span><span class="nb-faded-text">(string $recipientAddress, string $groupId)</span> : <a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a></code><div class="description"><p class="short_description">Add an email address to a group as a member</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$recipientAddress</th><td>string</td><td><em><p>Email address, member id, or group id</p></em></td></tr><tr><th>$groupId</th><td>string</td><td><em><p>The unique id of the group</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a></td><td>The member entry returned by the server</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::addOwnerToGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">addOwnerToGroup</span><span class="nb-faded-text">(string $email, string $groupId)</span> : <a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a></code><div class="description"><p class="short_description">Add an email as an owner of a group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$email</th><td>string</td><td><em><p>Owner's email</p> +</em></td></tr><tr><th>$groupId</th><td>string</td><td><em><p>Group ownership to be checked for</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a></td><td>The OwnerEntry returned by the server</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::addRecipientToEmailList()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">addRecipientToEmailList</span><span class="nb-faded-text">(string $recipientAddress, string $emailList)</span> : <a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a></code><div class="description"><p class="short_description">Add a specified recipient to an existing emailList.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$recipientAddress</th><td>string</td><td><em><p>The address of the recipient to be + added to the email list.</p></em></td></tr><tr><th>$emailList</th><td>string</td><td><em><p>The name of the email address to which the + recipient should be added.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a></td><td>The recipient entry + created by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::createEmailList()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">createEmailList</span><span class="nb-faded-text">(string $emailList)</span> : <a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a></code><div class="description"><p class="short_description">Create a new email list.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$emailList</th><td>string</td><td><em><p>The name of the email list to be created.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a></td><td>The email list entry + as created on the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::createGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">createGroup</span><span class="nb-faded-text">(string $groupId, string $groupName, string $description = null, string $emailPermission = null)</span> : <a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></code><div class="description"><p class="short_description">Create a new group.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$groupId</th><td>string</td><td><em><p>A unique identifier for the group</p></em></td></tr><tr><th>$groupName</th><td>string</td><td><em><p>The name of the group</p></em></td></tr><tr><th>$description</th><td>string</td><td><em><p>A description of the group</p></em></td></tr><tr><th>$emailPermission</th><td>string</td><td><em><p>The subscription permission of the group</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></td><td>The group entry as created on the server.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::createNickname()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">createNickname</span><span class="nb-faded-text">(string $username, string $nickname)</span> : <a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></code><div class="description"><p class="short_description">Create a nickname for a given user.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username to which the new nickname should + be associated.</p></em></td></tr><tr><th>$nickname</th><td>string</td><td><em><p>The new nickname to be created.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></td><td>The nickname entry which was + created by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::createUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">createUser</span><span class="nb-faded-text">(string $username, string $givenName, string $familyName, string $password, $passwordHashFunction = null, string $quotaLimitInMB = null)</span> : <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></code><div class="description"><p class="short_description">Create a new user entry and send it to the Google Apps servers.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username for the new user.</p></em></td></tr><tr><th>$givenName</th><td>string</td><td><em><p>The given name for the new user.</p></em></td></tr><tr><th>$familyName</th><td>string</td><td><em><p>The family name for the new user.</p></em></td></tr><tr><th>$password</th><td>string</td><td><em><p>The password for the new user as a plaintext string + (if $passwordHashFunction is null) or a SHA-1 hashed + value (if $passwordHashFunction = 'SHA-1').</p> +</em></td></tr><tr><th>$passwordHashFunction</th><td></td><td><em></em></td></tr><tr><th>$quotaLimitInMB</th><td>string</td><td><em><p>(optional) The quota limit for the new user in MB.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td>(optional) The new user entry as returned by + server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::delete()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">delete</span><span class="nb-faded-text">(mixed $data, integer $remainingRedirects = null)</span> : void</code><div class="description"><p class="short_description">DELETE entry with client object +This method overrides the default behavior of Zend_Gdata_App, +providing support for Zend_Gdata_Gapps_ServiceException.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or URL to delete</p></em></td></tr><tr><th>$remainingRedirects</th><td>integer</td><td><em><p>(optional)</p> +</em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::deleteEmailList()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">deleteEmailList</span><span class="nb-faded-text">(string $emailList)</span> : void</code><div class="description"><p class="short_description">Delete a specified email list.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$emailList</th><td>string</td><td><em><p>The name of the emailList to be deleted.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::deleteGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">deleteGroup</span><span class="nb-faded-text">(string $groupId)</span> : void</code><div class="description"><p class="short_description">Delete a group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$groupId</th><td>string</td><td><em><p>The unique identifier for the group</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::deleteNickname()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">deleteNickname</span><span class="nb-faded-text">(string $nickname)</span> : void</code><div class="description"><p class="short_description">Delete a specified nickname.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$nickname</th><td>string</td><td><em><p>The name of the nickname to be deleted.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::deleteUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">deleteUser</span><span class="nb-faded-text">(string $username)</span> : void</code><div class="description"><p class="short_description">Delete a user by username.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username associated with the user who + should be deleted.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::enableRequestDebugLogging()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">enableRequestDebugLogging</span><span class="nb-faded-text">(string $logfile)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">This method enables logging of requests by changing the +Zend_Http_Client_Adapter used for performing the requests.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::enableRequestDebugLogging()">\Zend_Gdata_App::enableRequestDebugLogging()</a><a href="../files/Gdata.html#\Zend_Gdata::enableRequestDebugLogging()">\Zend_Gdata::enableRequestDebugLogging()</a></small></div><div class="code-tabs"><div class="long-description"><p>NOTE: This will not work if you have customized the adapter +already to use a proxy server or other interface.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$logfile</th><td>string</td><td><em><p>The logfile to use when logging the requests</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::generateIfMatchHeaderData()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">generateIfMatchHeaderData</span><span class="nb-faded-text">( $data, $allowWeek)</span> : string | null</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Returns the data for an If-Match header based on the current Etag +property.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::generateIfMatchHeaderData()">\Zend_Gdata_App::generateIfMatchHeaderData()</a><a href="../files/Gdata.html#\Zend_Gdata::generateIfMatchHeaderData()">\Zend_Gdata::generateIfMatchHeaderData()</a></small></div><div class="code-tabs"><div class="long-description"><p>If Etags are not supported by the server or cannot be +extracted from the data, then null will be returned.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$data</th><td></td><td><em></em></td></tr><tr><th>$allowWeek</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string | null</td><td>$data</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::get()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">get</span><span class="nb-faded-text">(string $uri, array $extraHeaders = array())</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><p class="short_description">GET a URI using client object.</p></div><div class="code-tabs"><div class="long-description"><p>This method overrides the default behavior of Zend_Gdata_App, +providing support for Zend_Gdata_Gapps_ServiceException.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$uri</th><td>string</td><td><em><p>GET URI</p></em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getBaseUrl()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getBaseUrl</span><span class="nb-faded-text">(string $domain = null)</span> : void</code><div class="description"><p class="short_description">Returns the base URL used to access the Google Apps service, based +on the current domain.</p></div><div class="code-tabs"><div class="long-description"><p>The current domain can be temporarily +overridden by providing a fully qualified domain as $domain.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$domain</th><td>string</td><td><em><p>(optional) A fully-qualified domain to use + instead of the default domain for this service instance.</p> +</em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getDomain()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getDomain</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Get domain for this service instance.</p></div><div class="code-tabs"><div class="long-description"><p>This should be a fully qualified +domain, such as 'foo.example.com'. If no domain is set, null will be +returned.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>The domain to be used for this session, or null if not + set.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getEmailListEntry()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getEmailListEntry</span><span class="nb-faded-text">(mixed $location)</span> : <a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a></code><div class="description"><p class="short_description">Retreive a single EmailListEntry object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getEmailListFeed()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getEmailListFeed</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></code><div class="description"><p class="short_description">Retreive EmailListFeed object containing multiple EmailListEntry +objects.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>(optional) The location for the feed, as a URL + or Query.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getEmailListRecipientEntry()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getEmailListRecipientEntry</span><span class="nb-faded-text">(mixed $location)</span> : <a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a></code><div class="description"><p class="short_description">Retreive a single EmailListRecipientEntry object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getEmailListRecipientFeed()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getEmailListRecipientFeed</span><span class="nb-faded-text">(mixed $location)</span> : <a href="../files/Gdata.Gapps.EmailListRecipientFeed.html#\Zend_Gdata_Gapps_EmailListRecipientFeed">\Zend_Gdata_Gapps_EmailListRecipientFeed</a></code><div class="description"><p class="short_description">Retreive EmailListRecipientFeed object containing multiple +EmailListRecipientEntry objects.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListRecipientFeed.html#\Zend_Gdata_Gapps_EmailListRecipientFeed">\Zend_Gdata_Gapps_EmailListRecipientFeed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getEntry()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getEntry</span><span class="nb-faded-text">(mixed $location, $className = 'Zend_Gdata_Entry')</span> : string | <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve entry as string or object</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::getEntry()">\Zend_Gdata::getEntry()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location as string or Zend_Gdata_Query</p></em></td></tr><tr><th>$className</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string | <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></td><td>Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getFeed()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getFeed</span><span class="nb-faded-text">(mixed $location, string $className = 'Zend_Gdata_Feed')</span> : string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve feed as string or object</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::getFeed()">\Zend_Gdata::getFeed()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location as string or Zend_Gdata_Query</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class type to use for returning the feed</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td>Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getGroupEntry()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getGroupEntry</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></code><div class="description"><p class="short_description">Retreive a single GroupEntry object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getGroupFeed()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getGroupFeed</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></code><div class="description"><p class="short_description">Retreive GroupFeed object containing multiple GroupEntry +objects.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>(optional) The location for the feed, as a URL + or Query.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getGzipEnabled()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getGzipEnabled</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get the HTTP override state</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getGzipEnabled()">\Zend_Gdata_App::getGzipEnabled()</a><a href="../files/Gdata.html#\Zend_Gdata::getGzipEnabled()">\Zend_Gdata::getGzipEnabled()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getHttpClient()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getHttpClient</span><span class="nb-faded-text">()</span> : <a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get the Zend_Http_Client object used for communication</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getHttpClient()">\Zend_Gdata_App::getHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::getHttpClient()">\Zend_Gdata::getHttpClient()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getHttpMethodOverride()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getHttpMethodOverride</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get the HTTP override state</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getHttpMethodOverride()">\Zend_Gdata_App::getHttpMethodOverride()</a><a href="../files/Gdata.html#\Zend_Gdata::getHttpMethodOverride()">\Zend_Gdata::getHttpMethodOverride()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getMajorProtocolVersion()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getMajorProtocolVersion</span><span class="nb-faded-text">()</span> : int</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get the major protocol version that is in use.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getMajorProtocolVersion()">\Zend_Gdata_App::getMajorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::getMajorProtocolVersion()">\Zend_Gdata::getMajorProtocolVersion()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>int</td><td>The major protocol version in use.</td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_majorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getMaxRedirects()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getMaxRedirects</span><span class="nb-faded-text">()</span> : int</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get the maximum number of redirects to follow during HTTP operations</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getMaxRedirects()">\Zend_Gdata_App::getMaxRedirects()</a><a href="../files/Gdata.html#\Zend_Gdata::getMaxRedirects()">\Zend_Gdata::getMaxRedirects()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>int</td><td>Maximum number of redirects to follow</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getMemberEntry()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getMemberEntry</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a></code><div class="description"><p class="short_description">Retreive a single MemberEntry object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getMemberFeed()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getMemberFeed</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.MemberFeed.html#\Zend_Gdata_Gapps_MemberFeed">\Zend_Gdata_Gapps_MemberFeed</a></code><div class="description"><p class="short_description">Retreive MemberFeed object containing multiple MemberEntry +objects.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>(optional) The location for the feed, as a URL + or Query.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.MemberFeed.html#\Zend_Gdata_Gapps_MemberFeed">\Zend_Gdata_Gapps_MemberFeed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getMinorProtocolVersion()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getMinorProtocolVersion</span><span class="nb-faded-text">()</span> : \(int | \NULL)</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get the minor protocol version that is in use.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getMinorProtocolVersion()">\Zend_Gdata_App::getMinorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::getMinorProtocolVersion()">\Zend_Gdata::getMinorProtocolVersion()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\(int | \NULL)</td><td>The major protocol version in use, or NULL if no + minor version is specified.</td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_minorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getNextFeed()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNextFeed</span><span class="nb-faded-text">(<a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> $feed, string $className = null)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve next set of results based on a given feed.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getNextFeed()">\Zend_Gdata_App::getNextFeed()</a><a href="../files/Gdata.html#\Zend_Gdata::getNextFeed()">\Zend_Gdata::getNextFeed()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$feed</th><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td><em><p>The feed from which to + retreive the next set of results.</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>(optional) The class of feed to be returned. + If null, the next feed (if found) will be the same class as + the feed that was given as the first argument.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</td><td>Returns a + Zend_Gdata_App_Feed or null if no next set of results + exists.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getNicknameEntry()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNicknameEntry</span><span class="nb-faded-text">(mixed $location)</span> : <a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></code><div class="description"><p class="short_description">Retreive a single NicknameEntry object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getNicknameFeed()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNicknameFeed</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></code><div class="description"><p class="short_description">Retreive NicknameFeed object containing multiple NicknameEntry objects.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>(optional) The location for the feed, as a URL + or Query.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getOwnerEntry()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getOwnerEntry</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a></code><div class="description"><p class="short_description">Retreive a single OwnerEntry object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getOwnerFeed()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getOwnerFeed</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.OwnerFeed.html#\Zend_Gdata_Gapps_OwnerFeed">\Zend_Gdata_Gapps_OwnerFeed</a></code><div class="description"><p class="short_description">Retreive OwnerFeed object containing multiple OwnerEntry +objects.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>(optional) The location for the feed, as a URL + or Query.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.OwnerFeed.html#\Zend_Gdata_Gapps_OwnerFeed">\Zend_Gdata_Gapps_OwnerFeed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getPreviousFeed()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getPreviousFeed</span><span class="nb-faded-text">(<a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> $feed, string $className = null)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve previous set of results based on a given feed.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getPreviousFeed()">\Zend_Gdata_App::getPreviousFeed()</a><a href="../files/Gdata.html#\Zend_Gdata::getPreviousFeed()">\Zend_Gdata::getPreviousFeed()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$feed</th><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td><em><p>The feed from which to + retreive the previous set of results.</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>(optional) The class of feed to be returned. + If null, the previous feed (if found) will be the same class as + the feed that was given as the first argument.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</td><td>Returns a + Zend_Gdata_App_Feed or null if no previous set of results + exists.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getStaticHttpClient()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getStaticHttpClient</span><span class="nb-faded-text">()</span> : <a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Gets the HTTP client object.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getStaticHttpClient()">\Zend_Gdata_App::getStaticHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::getStaticHttpClient()">\Zend_Gdata::getStaticHttpClient()</a></small></div><div class="code-tabs"><div class="long-description"><p>If none is set, a new Zend_Http_Client will be used.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getUserEntry()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getUserEntry</span><span class="nb-faded-text">(mixed $location)</span> : <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></code><div class="description"><p class="short_description">Retreive a single UserEntry object.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getUserFeed()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getUserFeed</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Gapps.UserFeed.html#\Zend_Gdata_Gapps_UserFeed">\Zend_Gdata_Gapps_UserFeed</a></code><div class="description"><p class="short_description">Retrieve a UserFeed containing multiple UserEntry objects.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$location</th><td>mixed</td><td><em><p>(optional) The location for the feed, as a URL + or Query.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserFeed.html#\Zend_Gdata_Gapps_UserFeed">\Zend_Gdata_Gapps_UserFeed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::getVerboseExceptionMessages()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getVerboseExceptionMessages</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get whether to use verbose exception messages</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getVerboseExceptionMessages()">\Zend_Gdata_App::getVerboseExceptionMessages()</a><a href="../files/Gdata.html#\Zend_Gdata::getVerboseExceptionMessages()">\Zend_Gdata::getVerboseExceptionMessages()</a></small></div><div class="code-tabs"><div class="long-description"><p>In the case of HTTP errors, use the body of the HTTP response +in the exception message.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::import()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">import</span><span class="nb-faded-text">(string $uri, <a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $client = null, string $className = 'Zend_Gdata_App_Feed')</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">static</span><p class="short_description">Imports a feed located at $uri.</p></div><div class="code-tabs"><div class="long-description"><p>This method overrides the default behavior of Zend_Gdata_App, +providing support for Zend_Gdata_Gapps_ServiceException.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$uri</th><td>string</td><td><em></em></td></tr><tr><th>$client</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em><p>(optional) The client used for + communication</p> +</em></td></tr><tr><th>$className</th><td>string</td><td><em><p>(optional) The class which is used as the + return type</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::importFile()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">importFile</span><span class="nb-faded-text">(string $filename, string $className = 'Zend_Gdata_App_Feed', string $useIncludePath = false)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Imports a feed from a file located at $filename.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::importFile()">\Zend_Gdata_App::importFile()</a><a href="../files/Gdata.html#\Zend_Gdata::importFile()">\Zend_Gdata::importFile()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$filename</th><td>string</td><td><em></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class which is used as the return type</p></em></td></tr><tr><th>$useIncludePath</th><td>string</td><td><em><p>Whether the include_path should be searched</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::importString()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">importString</span><span class="nb-faded-text">(string $string, string $className = 'Zend_Gdata_App_Feed', $majorProtocolVersion = null, $minorProtocolVersion = null)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Imports a feed represented by $string.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::importString()">\Zend_Gdata_App::importString()</a><a href="../files/Gdata.html#\Zend_Gdata::importString()">\Zend_Gdata::importString()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$string</th><td>string</td><td><em></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class which is used as the return type</p></em></td></tr><tr><th>$majorProtocolVersion</th><td></td><td><em></em></td></tr><tr><th>$minorProtocolVersion</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::importUrl()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">importUrl</span><span class="nb-faded-text">(string $url, string $className = 'Zend_Gdata_App_Feed', array $extraHeaders = array())</span> : string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Imports the specified URL (non-statically).</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::importUrl()">\Zend_Gdata_App::importUrl()</a><a href="../files/Gdata.html#\Zend_Gdata::importUrl()">\Zend_Gdata::importUrl()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$url</th><td>string</td><td><em><p>The URL to import</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class which is used as the return type</p></em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td>Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertEmailList()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertEmailList</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a> $emailList, string $uri = null)</span> : <a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a></code><div class="description"><p class="short_description">Create a new email list from an EmailListEntry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$emailList</th><td><a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a></td><td><em><p>The email list entry + to insert.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URI where the email list should be + uploaded to. If null, the default email list creation URI for + this domain will be used.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListEntry.html#\Zend_Gdata_Gapps_EmailListEntry">\Zend_Gdata_Gapps_EmailListEntry</a></td><td>The inserted email list entry + as returned by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertEmailListRecipient()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertEmailListRecipient</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a> $recipient, string $uri = null)</span> : <a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a></code><div class="description"><p class="short_description">Create a new email list recipient from an EmailListRecipientEntry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$recipient</th><td><a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a></td><td><em><p>The recipient + entry to insert.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URI where the recipient should be + uploaded to. If null, the default recipient creation URI for + this domain will be used.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListRecipientEntry.html#\Zend_Gdata_Gapps_EmailListRecipientEntry">\Zend_Gdata_Gapps_EmailListRecipientEntry</a></td><td>The inserted + recipient entry as returned by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertEntry()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertEntry</span><span class="nb-faded-text">(mixed $data, string $uri, string $className = 'Zend_Gdata_App_Entry', array $extraHeaders = array())</span> : <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Inserts an entry to a given URI and returns the response as a +fully formed Entry.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::insertEntry()">\Zend_Gdata_App::insertEntry()</a><a href="../files/Gdata.html#\Zend_Gdata::insertEntry()">\Zend_Gdata::insertEntry()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML to post</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>POST URI</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class of entry to be returned.</p></em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></td><td>The entry returned by the service after + insertion.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertGroup</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a> $group, string $uri = null)</span> : <a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></code><div class="description"><p class="short_description">Create a new group from a GroupEntry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$group</th><td><a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></td><td><em><p>The group entry to insert.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URI where the group should be + uploaded to. If null, the default user creation URI for + this domain will be used.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></td><td>The inserted group entry as + returned by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertMember()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertMember</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a> $member, string $uri = null)</span> : <a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a></code><div class="description"><p class="short_description">Create a new member from a MemberEntry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$member</th><td><a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a></td><td><em><p>The member entry to insert.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URI where the group should be + uploaded to. If null, the default user creation URI for + this domain will be used.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.MemberEntry.html#\Zend_Gdata_Gapps_MemberEntry">\Zend_Gdata_Gapps_MemberEntry</a></td><td>The inserted member entry as + returned by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertNickname()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertNickname</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a> $nickname, string $uri = null)</span> : <a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></code><div class="description"><p class="short_description">Create a new nickname from a NicknameEntry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$nickname</th><td><a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></td><td><em><p>The nickname entry to + insert.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URI where the nickname should be + uploaded to. If null, the default nickname creation URI for + this domain will be used.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></td><td>The inserted nickname entry as + returned by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertOwner()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertOwner</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a> $owner, string $uri = null)</span> : <a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a></code><div class="description"><p class="short_description">Create a new group from a OwnerEntry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$owner</th><td><a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a></td><td><em><p>The owner entry to insert.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URI where the owner should be + uploaded to. If null, the default user creation URI for + this domain will be used.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.OwnerEntry.html#\Zend_Gdata_Gapps_OwnerEntry">\Zend_Gdata_Gapps_OwnerEntry</a></td><td>The inserted owner entry as + returned by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::insertUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">insertUser</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a> $user, string $uri = null)</span> : <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></code><div class="description"><p class="short_description">Create a new user from a UserEntry.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$user</th><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td><em><p>The user entry to insert.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URI where the user should be + uploaded to. If null, the default user creation URI for + this domain will be used.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td>The inserted user entry as + returned by the server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::isAuthenticated()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">isAuthenticated</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Determines whether service object is authenticated.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::isAuthenticated()">\Zend_Gdata::isAuthenticated()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td>True if service object is authenticated, false otherwise.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::isMember()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">isMember</span><span class="nb-faded-text">(string $memberId, string $groupId)</span> : bool</code><div class="description"><p class="short_description">Check to see if a member id or group id is a member of group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$memberId</th><td>string</td><td><em><p>Member id or group group id</p></em></td></tr><tr><th>$groupId</th><td>string</td><td><em><p>Group to be checked for</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>bool</td><td>True, if given entity is a member</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::isOwner()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">isOwner</span><span class="nb-faded-text">(string $email, string $groupId)</span> : bool</code><div class="description"><p class="short_description">Checks to see if an email is an owner of a group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$email</th><td>string</td><td><em><p>Owner's email</p> +</em></td></tr><tr><th>$groupId</th><td>string</td><td><em><p>Group ownership to be checked for</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>bool</td><td>True, if given entity is an owner</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::performHttpRequest()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">performHttpRequest</span><span class="nb-faded-text">(string $method, string $url, array $headers = array(), string $body = null, string $contentType = null, int $remainingRedirects = null)</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Performs a HTTP request using the specified method.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::performHttpRequest()">\Zend_Gdata::performHttpRequest()</a></small></div><div class="code-tabs"><div class="long-description"><p>Overrides the definition in the parent (Zend_Gdata_App) +and uses the Zend_Gdata_HttpClient functionality +to filter the HTTP requests and responses.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$method</th><td>string</td><td><em><p>The HTTP method for the request - + 'GET', 'POST', 'PUT', 'DELETE'</p> +</em></td></tr><tr><th>$url</th><td>string</td><td><em><p>The URL to which this request is being performed, + or null if found in $data</p> +</em></td></tr><tr><th>$headers</th><td>array</td><td><em><p>An associative array of HTTP headers + for this request</p></em></td></tr><tr><th>$body</th><td>string</td><td><em><p>The body of the HTTP request</p></em></td></tr><tr><th>$contentType</th><td>string</td><td><em><p>The value for the content type of the + request body</p></em></td></tr><tr><th>$remainingRedirects</th><td>int</td><td><em><p>Number of redirects to follow + if requests results in one</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td>The response object</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::post()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">post</span><span class="nb-faded-text">(mixed $data, string $uri = null, integer $remainingRedirects = null, string $contentType = null, $extraHeaders = null)</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><p class="short_description">POST data with client object.</p></div><div class="code-tabs"><div class="long-description"><p>This method overrides the default behavior of Zend_Gdata_App, +providing support for Zend_Gdata_Gapps_ServiceException.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML to post</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) POST URI</p> +</em></td></tr><tr><th>$remainingRedirects</th><td>integer</td><td><em><p>(optional)</p> +</em></td></tr><tr><th>$contentType</th><td>string</td><td><em><p>Content-type of the data</p> +</em></td></tr><tr><th>$extraHeaders</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::prepareRequest()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">prepareRequest</span><span class="nb-faded-text">(string $method, string $url = null, array $headers = array(), mixed $data = null, string $contentTypeOverride = null)</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Provides pre-processing for HTTP requests to APP services.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::prepareRequest()">\Zend_Gdata_App::prepareRequest()</a><a href="../files/Gdata.html#\Zend_Gdata::prepareRequest()">\Zend_Gdata::prepareRequest()</a></small></div><div class="code-tabs"><div class="long-description"><ol> +<li>Checks the $data element and, if it's an entry, extracts the XML, +multipart data, edit link (PUT,DELETE), etc.</li> +<li>If $data is a string, sets the default content-type header as +'application/atom+xml' if it's not already been set.</li> +<li>Adds a x-http-method override header and changes the HTTP method +to 'POST' if necessary as per getHttpMethodOverride()</li> +</ol></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$method</th><td>string</td><td><em><p>The HTTP method for the request - 'GET', 'POST', + 'PUT', 'DELETE'</p> +</em></td></tr><tr><th>$url</th><td>string</td><td><em><p>The URL to which this request is being performed, + or null if found in $data</p> +</em></td></tr><tr><th>$headers</th><td>array</td><td><em><p>An associative array of HTTP headers for this + request</p></em></td></tr><tr><th>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML for the + body of the request</p></em></td></tr><tr><th>$contentTypeOverride</th><td>string</td><td><em><p>The override value for the + content type of the request body</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>An associative array containing the determined + 'method', 'url', 'data', 'headers', 'contentType'</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::put()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">put</span><span class="nb-faded-text">(mixed $data, string $uri = null, integer $remainingRedirects = null, string $contentType = null, $extraHeaders = null)</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><p class="short_description">PUT data with client object +This method overrides the default behavior of Zend_Gdata_App, +providing support for Zend_Gdata_Gapps_ServiceException.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML to post</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) PUT URI</p> +</em></td></tr><tr><th>$remainingRedirects</th><td>integer</td><td><em><p>(optional)</p> +</em></td></tr><tr><th>$contentType</th><td>string</td><td><em><p>Content-type of the data</p> +</em></td></tr><tr><th>$extraHeaders</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::registerPackage()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">registerPackage</span><span class="nb-faded-text">(string $name)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Adds a Zend Framework package to the $_registeredPackages array.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::registerPackage()">\Zend_Gdata_App::registerPackage()</a><a href="../files/Gdata.html#\Zend_Gdata::registerPackage()">\Zend_Gdata::registerPackage()</a></small></div><div class="code-tabs"><div class="long-description"><p>This array is searched when using the magic __call method below +to instantiante new objects.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$name</th><td>string</td><td><em><p>The name of the package (eg Zend_Gdata_App)</p> +</em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::removeMemberFromGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">removeMemberFromGroup</span><span class="nb-faded-text">(string $memberId, string $groupId)</span> : void</code><div class="description"><p class="short_description">Remove a member id from a group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$memberId</th><td>string</td><td><em><p>Member id or group id</p></em></td></tr><tr><th>$groupId</th><td>string</td><td><em><p>The unique id of the group</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::removeOwnerFromGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">removeOwnerFromGroup</span><span class="nb-faded-text">(string $email, string $groupId)</span> : void</code><div class="description"><p class="short_description">Remove email as an owner of a group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$email</th><td>string</td><td><em><p>Owner's email</p> +</em></td></tr><tr><th>$groupId</th><td>string</td><td><em><p>The unique identifier for the group</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::removeRecipientFromEmailList()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">removeRecipientFromEmailList</span><span class="nb-faded-text">(string $recipientAddress, string $emailList)</span> : void</code><div class="description"><p class="short_description">Remove a specified recipient from an email list.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$recipientAddress</th><td>string</td><td><em><p>The recipient to be removed.</p></em></td></tr><tr><th>$emailList</th><td>string</td><td><em><p>The list from which the recipient should + be removed.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::restoreUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">restoreUser</span><span class="nb-faded-text">(string $username)</span> : <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></code><div class="description"><p class="short_description">Mark a given user as not suspended.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username associated with the user who + should be restored.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td>The UserEntry for the modified + user.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveAllEmailLists()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveAllEmailLists</span><span class="nb-faded-text">()</span> : <a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></code><div class="description"><p class="short_description">Retrieve all email lists associated with the curent domain.</p></div><div class="code-tabs"><div class="long-description"><p>Be aware that +calling this function on a domain with many email lists will take a +signifigant amount of time to complete. On larger domains this may +may cause execution to timeout without proper precautions in place.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></td><td>The list of email lists found + as Zend_Gdata_Gapps_EmailListEntry objects.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveAllEntriesForFeed()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveAllEntriesForFeed</span><span class="nb-faded-text">(object $feed)</span> : mixed</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve all entries for a feed, iterating through pages as necessary.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::retrieveAllEntriesForFeed()">\Zend_Gdata_App::retrieveAllEntriesForFeed()</a><a href="../files/Gdata.html#\Zend_Gdata::retrieveAllEntriesForFeed()">\Zend_Gdata::retrieveAllEntriesForFeed()</a></small></div><div class="code-tabs"><div class="long-description"><p>Be aware that calling this function on a large dataset will take a +significant amount of time to complete. In some cases this may cause +execution to timeout without proper precautions in place.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$feed</th><td>object</td><td><em><p>The feed to iterate through.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td>A new feed of the same type as the one originally + passed in, containing all relevent entries.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveAllGroups()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveAllGroups</span><span class="nb-faded-text">()</span> : <a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></code><div class="description"><p class="short_description">Retrieve all groups in the current domain.</p></div><div class="code-tabs"><div class="long-description"><p>Be aware that +calling this function on a domain with many groups will take a +signifigant amount of time to complete. On larger domains this may +may cause execution to timeout without proper precautions in place.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></td><td>Collection of Zend_Gdata_GroupEntry objects + representing all groups apart of the domain.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveAllMembers()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveAllMembers</span><span class="nb-faded-text">(string $groupId)</span> : <a href="../files/Gdata.Gapps.MemberFeed.html#\Zend_Gdata_Gapps_MemberFeed">\Zend_Gdata_Gapps_MemberFeed</a></code><div class="description"><p class="short_description">Retrieves all the members of a group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$groupId</th><td>string</td><td><em><p>The unique id of the group</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.MemberFeed.html#\Zend_Gdata_Gapps_MemberFeed">\Zend_Gdata_Gapps_MemberFeed</a></td><td>Collection of MemberEntry objects + representing all members apart of the group.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveAllNicknames()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveAllNicknames</span><span class="nb-faded-text">()</span> : <a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></code><div class="description"><p class="short_description">Retrieve all nicknames in the current domain.</p></div><div class="code-tabs"><div class="long-description"><p>Be aware that +calling this function on a domain with many nicknames will take a +signifigant amount of time to complete. On larger domains this may +may cause execution to timeout without proper precautions in place.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></td><td>Collection of Zend_Gdata_NicknameEntry + objects representing all nicknames in the domain.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveAllRecipients()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveAllRecipients</span><span class="nb-faded-text">( $emailList)</span> : <a href="../files/Gdata.Gapps.EmailListRecipientFeed.html#\Zend_Gdata_Gapps_EmailListRecipientFeed">\Zend_Gdata_Gapps_EmailListRecipientFeed</a></code><div class="description"><p class="short_description">Retrieve all recipients associated with an email list.</p></div><div class="code-tabs"><div class="long-description"><p>Be aware that +calling this function on a domain with many email lists will take a +signifigant amount of time to complete. On larger domains this may +may cause execution to timeout without proper precautions in place.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$emailList</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListRecipientFeed.html#\Zend_Gdata_Gapps_EmailListRecipientFeed">\Zend_Gdata_Gapps_EmailListRecipientFeed</a></td><td>The list of email lists + found as Zend_Gdata_Gapps_EmailListRecipientEntry objects.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveAllUsers()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveAllUsers</span><span class="nb-faded-text">()</span> : <a href="../files/Gdata.Gapps.UserFeed.html#\Zend_Gdata_Gapps_UserFeed">\Zend_Gdata_Gapps_UserFeed</a></code><div class="description"><p class="short_description">Retrieve all users in the current domain.</p></div><div class="code-tabs"><div class="long-description"><p>Be aware that +calling this function on a domain with many users will take a +signifigant amount of time to complete. On larger domains this may +may cause execution to timeout without proper precautions in place.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserFeed.html#\Zend_Gdata_Gapps_UserFeed">\Zend_Gdata_Gapps_UserFeed</a></td><td>Collection of Zend_Gdata_UserEntry + objects representing all users in the domain.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveEmailLists()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveEmailLists</span><span class="nb-faded-text">( $recipient)</span> : <a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></code><div class="description"><p class="short_description">Retrieve all email lists associated with a recipient.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$recipient</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></td><td>The list of email lists found as + Zend_Gdata_EmailListEntry objects.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveGroup</span><span class="nb-faded-text">(string $groupId)</span> : <a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></code><div class="description"><p class="short_description">Retrieves a group based on group id</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$groupId</th><td>string</td><td><em><p>The unique identifier for the group</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></td><td>The group entry as returned by the server.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveGroupOwners()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveGroupOwners</span><span class="nb-faded-text">(string $groupId)</span> : <a href="../files/Gdata.Gapps.OwnerFeed.html#\Zend_Gdata_Gapps_OwnerFeed">\Zend_Gdata_Gapps_OwnerFeed</a></code><div class="description"><p class="short_description">Retrieves all the owners of a group</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$groupId</th><td>string</td><td><em><p>The unique identifier for the group</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.OwnerFeed.html#\Zend_Gdata_Gapps_OwnerFeed">\Zend_Gdata_Gapps_OwnerFeed</a></td><td>Collection of Zend_Gdata_OwnerEntry + objects representing all owners apart of the group.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveGroups()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveGroups</span><span class="nb-faded-text">(string $memberId, bool $directOnly = null)</span> : <a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></code><div class="description"><p class="short_description">Retrieve all of the groups that a user is a member of</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$memberId</th><td>string</td><td><em><p>Member username</p></em></td></tr><tr><th>$directOnly</th><td>bool</td><td><em><p>(Optional) If true, members with direct association + only will be considered</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></td><td>Collection of Zend_Gdata_GroupEntry + objects representing all groups member is apart of in the domain.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveNickname()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveNickname</span><span class="nb-faded-text">(string $nickname)</span> : <a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></code><div class="description"><p class="short_description">Retrieve the entry for a specified nickname.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$nickname</th><td>string</td><td><em><p>The nickname to be retrieved.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameEntry.html#\Zend_Gdata_Gapps_NicknameEntry">\Zend_Gdata_Gapps_NicknameEntry</a></td><td>The requested nickname entry.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveNicknames()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveNicknames</span><span class="nb-faded-text">(string $username)</span> : <a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></code><div class="description"><p class="short_description">Retrieve all nicknames associated with a specific username.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username whose nicknames should be + returned.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></td><td>A feed containing all nicknames + for the given user, or null if</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrievePageOfEmailLists()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrievePageOfEmailLists</span><span class="nb-faded-text">( $startNickname = null)</span> : <a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></code><div class="description"><p class="short_description">Retrieve a page of email lists in alphabetical order, starting with the +provided email list.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$startNickname</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListFeed.html#\Zend_Gdata_Gapps_EmailListFeed">\Zend_Gdata_Gapps_EmailListFeed</a></td><td>Collection of Zend_Gdata_EmailListEntry + objects representing all nicknames in the domain.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrievePageOfGroups()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrievePageOfGroups</span><span class="nb-faded-text">(string $startGroup = null)</span> : <a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></code><div class="description"><p class="short_description">Retrieve a page of groups in alphabetical order, starting with the +provided group.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$startGroup</th><td>string</td><td><em><p>(optional) The first group to + retrieve. If null or not defined, the page will begin + with the first group in the domain.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupFeed.html#\Zend_Gdata_Gapps_GroupFeed">\Zend_Gdata_Gapps_GroupFeed</a></td><td>Collection of Zend_Gdata_GroupEntry + objects representing the groups in the domain.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrievePageOfMembers()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrievePageOfMembers</span><span class="nb-faded-text">(string $groupId, string $startMember = null)</span> : <a href="../files/Gdata.Gapps.MemberFeed.html#\Zend_Gdata_Gapps_MemberFeed">\Zend_Gdata_Gapps_MemberFeed</a></code><div class="description"><p class="short_description">Gets page of Members</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$groupId</th><td>string</td><td><em><p>The group id which should be searched.</p></em></td></tr><tr><th>$startMember</th><td>string</td><td><em><p>(optinal) The address of the first member, + or null to start with the first member in the list.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.MemberFeed.html#\Zend_Gdata_Gapps_MemberFeed">\Zend_Gdata_Gapps_MemberFeed</a></td><td>Collection of Zend_Gdata_MemberEntry + objects</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrievePageOfNicknames()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrievePageOfNicknames</span><span class="nb-faded-text">(string $startNickname = null)</span> : <a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></code><div class="description"><p class="short_description">Retrieve a page of nicknames in alphabetical order, starting with the +provided nickname.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$startNickname</th><td>string</td><td><em><p>(optional) The first nickname to + retrieve. If null or not declared, the page will begin with + the first nickname in the domain.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.NicknameFeed.html#\Zend_Gdata_Gapps_NicknameFeed">\Zend_Gdata_Gapps_NicknameFeed</a></td><td>Collection of Zend_Gdata_NicknameEntry + objects representing all nicknames in the domain.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrievePageOfRecipients()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrievePageOfRecipients</span><span class="nb-faded-text">( $emailList, string $startRecipient = null)</span> : <a href="../files/Gdata.Gapps.EmailListRecipientFeed.html#\Zend_Gdata_Gapps_EmailListRecipientFeed">\Zend_Gdata_Gapps_EmailListRecipientFeed</a></code><div class="description"><p class="short_description">Retrieve a page of email list recipients in alphabetical order, +starting with the provided email list recipient.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$emailList</th><td></td><td><em></em></td></tr><tr><th>$startRecipient</th><td>string</td><td><em><p>(optinal) The address of the first + recipient, or null to start with the first recipient in + the list.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.EmailListRecipientFeed.html#\Zend_Gdata_Gapps_EmailListRecipientFeed">\Zend_Gdata_Gapps_EmailListRecipientFeed</a></td><td>Collection of + Zend_Gdata_EmailListRecipientEntry objects representing all + recpients in the specified list.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrievePageOfUsers()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrievePageOfUsers</span><span class="nb-faded-text">(string $startUsername = null)</span> : <a href="../files/Gdata.Gapps.UserFeed.html#\Zend_Gdata_Gapps_UserFeed">\Zend_Gdata_Gapps_UserFeed</a></code><div class="description"><p class="short_description">Retrieve a page of users in alphabetical order, starting with the +provided username.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$startUsername</th><td>string</td><td><em><p>(optional) The first username to retrieve. + If null or not declared, the page will begin with the first + user in the domain.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserFeed.html#\Zend_Gdata_Gapps_UserFeed">\Zend_Gdata_Gapps_UserFeed</a></td><td>Collection of Zend_Gdata_UserEntry + objects representing all users in the domain.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::retrieveUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">retrieveUser</span><span class="nb-faded-text">(string $username)</span> : <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></code><div class="description"><p class="short_description">Retrieve a user based on their username.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username to search for.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td>The username to search for, or null + if no match found.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setDomain()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setDomain</span><span class="nb-faded-text">(string $value)</span> : void</code><div class="description"><p class="short_description">Set domain for this service instance.</p></div><div class="code-tabs"><div class="long-description"><p>This should be a fully qualified +domain, such as 'foo.example.com'.</p> + +<p>This value is used when calculating URLs for retrieving and posting +entries. If no value is specified, a URL will have to be manually +constructed prior to using any methods which interact with the Google +Apps provisioning service.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$value</th><td>string</td><td><em><p>The domain to be used for this session.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setGzipEnabled()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setGzipEnabled</span><span class="nb-faded-text">(boolean $enabled = false)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Toggle requesting gzip encoded responses</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setGzipEnabled()">\Zend_Gdata_App::setGzipEnabled()</a><a href="../files/Gdata.html#\Zend_Gdata::setGzipEnabled()">\Zend_Gdata::setGzipEnabled()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$enabled</th><td>boolean</td><td><em><p>Whether or not to enable gzipped responses</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setHttpClient()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setHttpClient</span><span class="nb-faded-text">(<a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $client, $applicationId = 'MyCompany-MyApp-1.0')</span> : <a href="../files/Gdata.App.html#\Zend_Gdata_App">\Zend_Gdata_App</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set the Zend_Http_Client object used for communication</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setHttpClient()">\Zend_Gdata_App::setHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::setHttpClient()">\Zend_Gdata::setHttpClient()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$client</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em><p>The client to use for communication</p></em></td></tr><tr><th>$applicationId</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.html#\Zend_Gdata_App">\Zend_Gdata_App</a></td><td>Provides a fluent interface</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setHttpMethodOverride()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setHttpMethodOverride</span><span class="nb-faded-text">(boolean $override = true)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Toggle using POST instead of PUT and DELETE HTTP methods</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setHttpMethodOverride()">\Zend_Gdata_App::setHttpMethodOverride()</a><a href="../files/Gdata.html#\Zend_Gdata::setHttpMethodOverride()">\Zend_Gdata::setHttpMethodOverride()</a></small></div><div class="code-tabs"><div class="long-description"><p>Some feed implementations do not accept PUT and DELETE HTTP +methods, or they can't be used because of proxies or other +measures. This allows turning on using POST where PUT and +DELETE would normally be used; in addition, an +X-Method-Override header will be sent with a value of PUT or +DELETE as appropriate.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$override</th><td>boolean</td><td><em><p>Whether to override PUT and DELETE with POST.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setMajorProtocolVersion()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setMajorProtocolVersion</span><span class="nb-faded-text">(int $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set the major protocol version that should be used.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setMajorProtocolVersion()">\Zend_Gdata_App::setMajorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::setMajorProtocolVersion()">\Zend_Gdata::setMajorProtocolVersion()</a></small></div><div class="code-tabs"><div class="long-description"><p>Values < 1 will +cause a Zend_Gdata_App_InvalidArgumentException to be thrown.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$value</th><td>int</td><td><em><p>The major protocol version to use.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_majorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setMaxRedirects()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setMaxRedirects</span><span class="nb-faded-text">(int $maxRedirects)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Set the maximum number of redirects to follow during HTTP operations</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setMaxRedirects()">\Zend_Gdata_App::setMaxRedirects()</a><a href="../files/Gdata.html#\Zend_Gdata::setMaxRedirects()">\Zend_Gdata::setMaxRedirects()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$maxRedirects</th><td>int</td><td><em><p>Maximum number of redirects to follow</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setMinorProtocolVersion()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setMinorProtocolVersion</span><span class="nb-faded-text">(\(int | \NULL) $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set the minor protocol version that should be used.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setMinorProtocolVersion()">\Zend_Gdata_App::setMinorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::setMinorProtocolVersion()">\Zend_Gdata::setMinorProtocolVersion()</a></small></div><div class="code-tabs"><div class="long-description"><p>If set to NULL, no +minor protocol version will be sent to the server. Values < 0 will +cause a Zend_Gdata_App_InvalidArgumentException to be thrown.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$value</th><td>\(int | \NULL)</td><td><em><p>The minor protocol version to use.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_minorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setStaticHttpClient()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setStaticHttpClient</span><span class="nb-faded-text">(<a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $httpClient)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Set the static HTTP client instance</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setStaticHttpClient()">\Zend_Gdata_App::setStaticHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::setStaticHttpClient()">\Zend_Gdata::setStaticHttpClient()</a></small></div><div class="code-tabs"><div class="long-description"><p>Sets the static HTTP client object to use for retrieving the feed.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$httpClient</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::setVerboseExceptionMessages()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setVerboseExceptionMessages</span><span class="nb-faded-text">(boolean $verbose)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Set whether to use verbose exception messages</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setVerboseExceptionMessages()">\Zend_Gdata_App::setVerboseExceptionMessages()</a><a href="../files/Gdata.html#\Zend_Gdata::setVerboseExceptionMessages()">\Zend_Gdata::setVerboseExceptionMessages()</a></small></div><div class="code-tabs"><div class="long-description"><p>In the case of HTTP errors, use the body of the HTTP response +in the exception message.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$verbose</th><td>boolean</td><td><em><p>Whether to use verbose exception messages</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::suspendUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">suspendUser</span><span class="nb-faded-text">(string $username)</span> : <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></code><div class="description"><p class="short_description">Mark a given user as suspended.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username associated with the user who + should be suspended.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td>The UserEntry for the modified + user.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::throwServiceExceptionIfDetected()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">throwServiceExceptionIfDetected</span><span class="nb-faded-text">(\Zend_Gdata_Exception $e)</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">Convert an exception to an ServiceException if an AppsForYourDomain +XML document is contained within the original exception's HTTP +response.</p></div><div class="code-tabs"><div class="long-description"><p>If conversion fails, throw the original error.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$e</th><td>\Zend_Gdata_Exception</td><td><em><p>The exception to convert.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr><tr><td>mixed</td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::updateEntry()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">updateEntry</span><span class="nb-faded-text">(mixed $data, string | null $uri = null, string | null $className = null, array $extraHeaders = array())</span> : <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Update an entry</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::updateEntry()">\Zend_Gdata_App::updateEntry()</a><a href="../files/Gdata.html#\Zend_Gdata::updateEntry()">\Zend_Gdata::updateEntry()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$data</th><td>mixed</td><td><em><p>Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')</p> +</em></td></tr><tr><th>$uri</th><td>string | null</td><td><em><p>The URI to send requests to, or null if $data + contains the URI.</p> +</em></td></tr><tr><th>$className</th><td>string | null</td><td><em><p>The name of the class that should be deserialized + from the server response. If null, then 'Zend_Gdata_App_Entry' + will be used.</p> +</em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></td><td>The entry returned from the server</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::updateGroup()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">updateGroup</span><span class="nb-faded-text">(string $groupId, string $groupName = null, string $description = null, string $emailPermission = null)</span> : <a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></code><div class="description"><p class="short_description">Update group properties with new values.</p></div><div class="code-tabs"><div class="long-description"><p>any property not defined will not +be updated</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$groupId</th><td>string</td><td><em><p>A unique identifier for the group</p></em></td></tr><tr><th>$groupName</th><td>string</td><td><em><p>The name of the group</p></em></td></tr><tr><th>$description</th><td>string</td><td><em><p>A description of the group</p></em></td></tr><tr><th>$emailPermission</th><td>string</td><td><em><p>The subscription permission of the group</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.GroupEntry.html#\Zend_Gdata_Gapps_GroupEntry">\Zend_Gdata_Gapps_GroupEntry</a></td><td>The group entry as updated on the server.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::updateUser()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">updateUser</span><span class="nb-faded-text">(string $username, <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a> $userEntry)</span> : <a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></code><div class="description"><p class="short_description">Overwrite a specified username with the provided UserEntry.</p></div><div class="code-tabs"><div class="long-description"><p>The +UserEntry does not need to contain an edit link.</p> + +<p>This method is provided for compliance with the Google Apps +Provisioning API specification. Normally users will instead want to +call UserEntry::save() instead.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$username</th><td>string</td><td><em><p>The username whose data will be overwritten.</p></em></td></tr><tr><th>$userEntry</th><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td><em><p>The user entry which + will be overwritten.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.UserEntry.html#\Zend_Gdata_Gapps_UserEntry">\Zend_Gdata_Gapps_UserEntry</a></td><td>The UserEntry returned by the + server.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td><em></em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd><a href="../files/ + Gdata.App.Entry.html#\Zend_Gdata_App_Entry::save">\Zend_Gdata_App_Entry::save</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::useObjectMapping()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">useObjectMapping</span><span class="nb-faded-text">(boolean $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Enable/disable the use of XML to object mapping.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::useObjectMapping()">\Zend_Gdata_App::useObjectMapping()</a><a href="../files/Gdata.html#\Zend_Gdata::useObjectMapping()">\Zend_Gdata::useObjectMapping()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$value</th><td>boolean</td><td><em><p>Pass in true to use the XML to object mapping. + Pass in false or null to disable it.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps::usingObjectMapping()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">usingObjectMapping</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Determine whether service object is using XML to object mapping.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::usingObjectMapping()">\Zend_Gdata_App::usingObjectMapping()</a><a href="../files/Gdata.html#\Zend_Gdata::usingObjectMapping()">\Zend_Gdata::usingObjectMapping()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td>True if service object is using XML to object mapping, + false otherwise.</td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer"> + Documentation was generated by + <a href="http://phpdoc.org">phpDocumentor + 2.0.0a12</a>. + </small></body></html> |