Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_Gapps_EmailListRecipientQuery Class Reference
Inheritance diagram for Zend_Gdata_Gapps_EmailListRecipientQuery:
Collaboration diagram for Zend_Gdata_Gapps_EmailListRecipientQuery:

Public Member Functions

 __construct ($domain=null, $emailListName=null, $startRecipient=null)
 setEmailListName ($value)
 getEmailListName ()
 setStartRecipient ($value)
 getStartRecipient ()
 getQueryUrl ()

Protected Attributes

 $_emailListName = null

Detailed Description

Definition at line 43 of file EmailListRecipientQuery.php.


Constructor & Destructor Documentation

__construct ( domain = null,
emailListName = null,
startRecipient = null 
)

Create a new instance.

Parameters:
string$domain(optional) The Google Apps-hosted domain to use when constructing query URIs.
string$emailListName(optional) Value for the emailListName property.
string$startRecipient(optional) Value for the startRecipient property.

Definition at line 64 of file EmailListRecipientQuery.php.

Here is the call graph for this function:


Member Function Documentation

Get the email list name to query for. If no name is set, null will be returned.

Parameters:
string$valueThe email list name to filter search results by, or null if disabled.

Definition at line 92 of file EmailListRecipientQuery.php.

Returns the URL generated for this query, based on it's current parameters.

Returns:
string A URL generated based on the state of this query.
Exceptions:
Zend_Gdata_App_InvalidArgumentException

Reimplemented from Zend_Gdata_Query.

Definition at line 136 of file EmailListRecipientQuery.php.

Here is the call graph for this function:

Get the first recipient which should be displayed when retrieving a list of email list recipients.

Returns:
string The first recipient to be returned, or null if disabled.

Definition at line 120 of file EmailListRecipientQuery.php.

setEmailListName ( value)

Set the email list name to query for. When set, only lists with a name matching this value will be returned in search results. Set to null to disable filtering by list name.

Parameters:
string$valueThe email list name to filter search results by, or null to disable.

Definition at line 80 of file EmailListRecipientQuery.php.

Here is the caller graph for this function:

setStartRecipient ( value)

Set the first recipient which should be displayed when retrieving a list of email list recipients.

Parameters:
string$valueThe first recipient to be returned, or null to disable.

Definition at line 104 of file EmailListRecipientQuery.php.

Here is the caller graph for this function:


Field Documentation

$_emailListName = null [protected]

Definition at line 52 of file EmailListRecipientQuery.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations