| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.apps.multidomain.client</title> |
| </head><body bgcolor="#f0f0f8"> |
| |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> |
| <tr bgcolor="#7799ee"> |
| <td valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="gdata.html"><font color="#ffffff">gdata</font></a>.<a href="gdata.apps.html"><font color="#ffffff">apps</font></a>.<a href="gdata.apps.multidomain.html"><font color="#ffffff">multidomain</font></a>.client</strong></big></big></font></td |
| ><td align=right valign=bottom |
| ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/apps/multidomain/client.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/apps/multidomain/client.py</a></font></td></tr></table> |
| <p><tt><a href="#MultiDomainProvisioningClient">MultiDomainProvisioningClient</a> simplifies Multidomain Provisioning API calls.<br> |
| <br> |
| <a href="#MultiDomainProvisioningClient">MultiDomainProvisioningClient</a> extends gdata.client.<a href="gdata.client.html#GDClient">GDClient</a> to ease interaction<br> |
| with the Google Multidomain Provisioning API. These interactions include the<br> |
| ability to create, retrieve, update and delete users and aliases in multiple<br> |
| domains.</tt></p> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#aa55cc"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> |
| <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="gdata.html">gdata</a><br> |
| </td><td width="25%" valign=top><a href="urllib.html">urllib</a><br> |
| </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ee77aa"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> |
| <td width="100%"><dl> |
| <dt><font face="helvetica, arial"><a href="gdata.client.html#GDClient">gdata.client.GDClient</a>(<a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>) |
| </font></dt><dd> |
| <dl> |
| <dt><font face="helvetica, arial"><a href="gdata.apps.multidomain.client.html#MultiDomainProvisioningClient">MultiDomainProvisioningClient</a> |
| </font></dt></dl> |
| </dd> |
| </dl> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="MultiDomainProvisioningClient">class <strong>MultiDomainProvisioningClient</strong></a>(<a href="gdata.client.html#GDClient">gdata.client.GDClient</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Client extension for the Google MultiDomain Provisioning API service.<br> |
| <br> |
| Attributes:<br> |
| host: string The hostname for the MultiDomain Provisioning API service.<br> |
| api_version: string The version of the MultiDomain Provisioning API.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.apps.multidomain.client.html#MultiDomainProvisioningClient">MultiDomainProvisioningClient</a></dd> |
| <dd><a href="gdata.client.html#GDClient">gdata.client.GDClient</a></dd> |
| <dd><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a></dd> |
| <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> |
| </dl> |
| <hr> |
| Methods defined here:<br> |
| <dl><dt><a name="MultiDomainProvisioningClient-CreateAlias"><strong>CreateAlias</strong></a> = <a href="#MultiDomainProvisioningClient-create_alias">create_alias</a>(self, user_email, alias_email, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-CreateUser"><strong>CreateUser</strong></a> = <a href="#MultiDomainProvisioningClient-create_user">create_user</a>(self, email, first_name, last_name, password, is_admin, hash_function<font color="#909090">=None</font>, suspended<font color="#909090">=None</font>, change_password<font color="#909090">=None</font>, ip_whitelisted<font color="#909090">=None</font>, quota<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-DeleteAlias"><strong>DeleteAlias</strong></a> = <a href="#MultiDomainProvisioningClient-delete_alias">delete_alias</a>(self, email, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-DeleteUser"><strong>DeleteUser</strong></a> = <a href="#MultiDomainProvisioningClient-delete_user">delete_user</a>(self, email, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-MakeMultidomainAliasProvisioningUri"><strong>MakeMultidomainAliasProvisioningUri</strong></a> = <a href="#MultiDomainProvisioningClient-make_multidomain_alias_provisioning_uri">make_multidomain_alias_provisioning_uri</a>(self, email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-MakeMultidomainProvisioningUri"><strong>MakeMultidomainProvisioningUri</strong></a> = <a href="#MultiDomainProvisioningClient-make_multidomain_provisioning_uri">make_multidomain_provisioning_uri</a>(self, feed_type, email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-MakeMultidomainUserProvisioningUri"><strong>MakeMultidomainUserProvisioningUri</strong></a> = <a href="#MultiDomainProvisioningClient-make_multidomain_user_provisioning_uri">make_multidomain_user_provisioning_uri</a>(self, email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RenameUser"><strong>RenameUser</strong></a> = <a href="#MultiDomainProvisioningClient-rename_user">rename_user</a>(self, old_email, new_email, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RetrieveAlias"><strong>RetrieveAlias</strong></a> = <a href="#MultiDomainProvisioningClient-retrieve_alias">retrieve_alias</a>(self, email, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RetrieveAllAliases"><strong>RetrieveAllAliases</strong></a> = <a href="#MultiDomainProvisioningClient-retrieve_all_aliases">retrieve_all_aliases</a>(self, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RetrieveAllPages"><strong>RetrieveAllPages</strong></a> = <a href="#MultiDomainProvisioningClient-retrieve_all_pages">retrieve_all_pages</a>(self, uri, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RetrieveAllUserAliases"><strong>RetrieveAllUserAliases</strong></a> = <a href="#MultiDomainProvisioningClient-retrieve_all_user_aliases">retrieve_all_user_aliases</a>(self, user_email, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RetrieveAllUsers"><strong>RetrieveAllUsers</strong></a> = <a href="#MultiDomainProvisioningClient-retrieve_all_users">retrieve_all_users</a>(self, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RetrieveUser"><strong>RetrieveUser</strong></a> = <a href="#MultiDomainProvisioningClient-retrieve_user">retrieve_user</a>(self, email, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-UpdateUser"><strong>UpdateUser</strong></a> = <a href="#MultiDomainProvisioningClient-update_user">update_user</a>(self, email, user_entry, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-__init__"><strong>__init__</strong></a>(self, domain, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Constructs a new client for the MultiDomain Provisioning API.<br> |
| <br> |
| Args:<br> |
| domain: string The Google Apps domain with MultiDomain Provisioning.<br> |
| auth_token: (optional) gdata.gauth.ClientLoginToken, AuthSubToken, or<br> |
| OAuthToken which authorizes this client to edit the email settings.<br> |
| kwargs: The other parameters to pass to the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a><br> |
| constructor.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-create_alias"><strong>create_alias</strong></a>(self, user_email, alias_email, **kwargs)</dt><dd><tt>Creates an alias in the domain with the given properties.<br> |
| <br> |
| Args:<br> |
| user_email: string The email address of the user.<br> |
| alias_email: string The first name of the user.<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-post">post</a>().<br> |
| <br> |
| Returns:<br> |
| A gdata.apps.multidomain.data.AliasEntry of the new alias</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-create_user"><strong>create_user</strong></a>(self, email, first_name, last_name, password, is_admin, hash_function<font color="#909090">=None</font>, suspended<font color="#909090">=None</font>, change_password<font color="#909090">=None</font>, ip_whitelisted<font color="#909090">=None</font>, quota<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates an user in the domain with the given properties.<br> |
| <br> |
| Args:<br> |
| email: string The email address of the user.<br> |
| first_name: string The first name of the user.<br> |
| last_name: string The last name of the user.<br> |
| password: string The password of the user.<br> |
| is_admin: Boolean Whether or not the user has administrator privileges.<br> |
| hash_function: string (optional) The name of the function used to hash the<br> |
| password.<br> |
| suspended: Boolean (optional) Whether or not the user is suspended.<br> |
| change_password: Boolean (optional) Whether or not the user must change<br> |
| password at first login.<br> |
| ip_whitelisted: Boolean (optional) Whether or not the user's ip is<br> |
| whitelisted.<br> |
| quota: string (optional) The value (in GB) of the user's quota.<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-post">post</a>().<br> |
| <br> |
| Returns:<br> |
| A gdata.apps.multidomain.data.UserEntry of the new user</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-delete_alias"><strong>delete_alias</strong></a>(self, email, **kwargs)</dt><dd><tt>Deletes the alias with the given email address.<br> |
| <br> |
| Args:<br> |
| email: string The email address of the alias to delete.<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-delete">delete</a>()<br> |
| <br> |
| Returns:<br> |
| An HTTP response object. See gdata.client.<a href="#MultiDomainProvisioningClient-request">request</a>().</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-delete_user"><strong>delete_user</strong></a>(self, email, **kwargs)</dt><dd><tt>Deletes the user with the given email address.<br> |
| <br> |
| Args:<br> |
| email: string The email address of the user to delete.<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-delete">delete</a>()<br> |
| <br> |
| Returns:<br> |
| An HTTP response object. See gdata.client.<a href="#MultiDomainProvisioningClient-request">request</a>().</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-make_multidomain_alias_provisioning_uri"><strong>make_multidomain_alias_provisioning_uri</strong></a>(self, email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt><dd><tt>Creates a resource feed URI for the MultiDomain Alias Provisioning API.<br> |
| <br> |
| Using this client's Google Apps domain, create a feed URI for multidomain<br> |
| alias provisioning in that domain. If an email address is provided, return a<br> |
| URI for that specific resource. If params are provided, append them as GET<br> |
| params.<br> |
| <br> |
| Args:<br> |
| email: string (optional) The email address of multidomain alias for which<br> |
| to make a feed URI.<br> |
| params: dict (optional) key -> value params to append as GET vars to the<br> |
| URI. Example: params={'start': 'my-resource-id'}<br> |
| <br> |
| Returns:<br> |
| A string giving the URI for multidomain alias provisioning for this<br> |
| client's Google Apps domain.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-make_multidomain_provisioning_uri"><strong>make_multidomain_provisioning_uri</strong></a>(self, feed_type, email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt><dd><tt>Creates a resource feed URI for the MultiDomain Provisioning API.<br> |
| <br> |
| Using this client's Google Apps domain, create a feed URI for multidomain<br> |
| provisioning in that domain. If an email address is provided, return a<br> |
| URI for that specific resource. If params are provided, append them as GET<br> |
| params.<br> |
| <br> |
| Args:<br> |
| feed_type: string The type of feed (user/alias)<br> |
| email: string (optional) The email address of multidomain resource for<br> |
| which to make a feed URI.<br> |
| params: dict (optional) key -> value params to append as GET vars to the<br> |
| URI. Example: params={'start': 'my-resource-id'}<br> |
| <br> |
| Returns:<br> |
| A string giving the URI for multidomain provisioning for this client's<br> |
| Google Apps domain.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-make_multidomain_user_provisioning_uri"><strong>make_multidomain_user_provisioning_uri</strong></a>(self, email<font color="#909090">=None</font>, params<font color="#909090">=None</font>)</dt><dd><tt>Creates a resource feed URI for the MultiDomain User Provisioning API.<br> |
| <br> |
| Using this client's Google Apps domain, create a feed URI for multidomain<br> |
| user provisioning in that domain. If an email address is provided, return a<br> |
| URI for that specific resource. If params are provided, append them as GET<br> |
| params.<br> |
| <br> |
| Args:<br> |
| email: string (optional) The email address of multidomain user for which<br> |
| to make a feed URI.<br> |
| params: dict (optional) key -> value params to append as GET vars to the<br> |
| URI. Example: params={'start': 'my-resource-id'}<br> |
| <br> |
| Returns:<br> |
| A string giving the URI for multidomain user provisioning for thisis that<br> |
| client's Google Apps domain.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-rename_user"><strong>rename_user</strong></a>(self, old_email, new_email, **kwargs)</dt><dd><tt>Renames an user's account to a different domain.<br> |
| <br> |
| Args:<br> |
| old_email: string The old email address of the user to rename.<br> |
| new_email: string The new email address for the user to be renamed.<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-put">put</a>()<br> |
| <br> |
| Returns:<br> |
| A gdata.apps.multidomain.data.UserRenameRequest representing the request.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-retrieve_alias"><strong>retrieve_alias</strong></a>(self, email, **kwargs)</dt><dd><tt>Retrieves a single alias in the domain.<br> |
| <br> |
| Args:<br> |
| email: string The email address of the alias to be retrieved<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-GetEntry">GetEntry</a>()<br> |
| <br> |
| Returns:<br> |
| A gdata.apps.multidomain.data.AliasEntry representing the alias</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-retrieve_all_aliases"><strong>retrieve_all_aliases</strong></a>(self, **kwargs)</dt><dd><tt>Retrieves all aliases in the domain.<br> |
| <br> |
| Args:<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-GetFeed">GetFeed</a>()<br> |
| <br> |
| Returns:<br> |
| A gdata.data.GDFeed of the domain aliases</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-retrieve_all_pages"><strong>retrieve_all_pages</strong></a>(self, uri, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt><dd><tt>Retrieves all pages from uri.<br> |
| <br> |
| Args:<br> |
| uri: The uri where the first page is.<br> |
| desired_class: Type of feed that is retrieved.<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-GetFeed">GetFeed</a>()<br> |
| <br> |
| Returns:<br> |
| A desired_class feed object.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-retrieve_all_user_aliases"><strong>retrieve_all_user_aliases</strong></a>(self, user_email, **kwargs)</dt><dd><tt>Retrieves all aliases for a given user in the domain.<br> |
| <br> |
| Args:<br> |
| user_email: string Email address of the user whose aliases<br> |
| are to be retrieved<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-GetFeed">GetFeed</a>()<br> |
| <br> |
| Returns:<br> |
| A gdata.data.GDFeed of the user aliases</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-retrieve_all_users"><strong>retrieve_all_users</strong></a>(self, **kwargs)</dt><dd><tt>Retrieves all users in all domains.<br> |
| <br> |
| Args:<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-GetFeed">GetFeed</a>()<br> |
| <br> |
| Returns:<br> |
| A gdata.data.GDFeed of the domain users</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-retrieve_user"><strong>retrieve_user</strong></a>(self, email, **kwargs)</dt><dd><tt>Retrieves a single user in the domain.<br> |
| <br> |
| Args:<br> |
| email: string The email address of the user to be retrieved<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-GetEntry">GetEntry</a>()<br> |
| <br> |
| Returns:<br> |
| A gdata.apps.multidomain.data.UserEntry representing the user</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-update_user"><strong>update_user</strong></a>(self, email, user_entry, **kwargs)</dt><dd><tt>Deletes the user with the given email address.<br> |
| <br> |
| Args:<br> |
| email: string The email address of the user to be updated.<br> |
| user_entry: UserEntry The user entry with updated values.<br> |
| kwargs: The other parameters to pass to gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>.<a href="#MultiDomainProvisioningClient-put">put</a>()<br> |
| <br> |
| Returns:<br> |
| A gdata.apps.multidomain.data.UserEntry representing the user</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>api_version</strong> = '2.0'</dl> |
| |
| <dl><dt><strong>auth_scopes</strong> = ('https://apps-apis.google.com/a/feeds/user/', 'https://apps-apis.google.com/a/feeds/policies/', 'https://apps-apis.google.com/a/feeds/alias/', 'https://apps-apis.google.com/a/feeds/groups/', 'https://apps-apis.google.com/a/feeds/compliance/audit/', 'https://apps-apis.google.com/a/feeds/migration/', 'https://apps-apis.google.com/a/feeds/emailsettings/2.0/')</dl> |
| |
| <dl><dt><strong>auth_service</strong> = 'apps'</dl> |
| |
| <dl><dt><strong>host</strong> = 'apps-apis.google.com'</dl> |
| |
| <dl><dt><strong>ssl</strong> = True</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br> |
| <dl><dt><a name="MultiDomainProvisioningClient-Batch"><strong>Batch</strong></a> = batch(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br> |
| <br> |
| Args:<br> |
| feed: A batch feed containing batch entries, each is an operation.<br> |
| uri: (optional) The uri to which the batch request feed should be POSTed.<br> |
| If none is provided, then the feed's edit link will be used.<br> |
| force: (optional) boolean set to True if you want the batch update to<br> |
| clobber all data. If False, the version in the information in the<br> |
| feed object will cause the server to check to see that no changes<br> |
| intervened between when you fetched the data and when you sent the<br> |
| changes.<br> |
| auth_token: (optional) An object which sets the Authorization HTTP header<br> |
| in its modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-ClientLogin"><strong>ClientLogin</strong></a> = client_login(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br> |
| <br> |
| In order to modify user specific data and read user private data, your<br> |
| application must be authorized by the user. One way to demonstrage<br> |
| authorization is by including a Client Login token in the Authorization<br> |
| HTTP header of all requests. This method requests the Client Login token<br> |
| by sending the user's email address, password, the name of the<br> |
| application, and the service code for the service which will be accessed<br> |
| by the application. If the username and password are correct, the server<br> |
| will respond with the client login code and a new ClientLoginToken<br> |
| object will be set in the client's auth_token member. With the auth_token<br> |
| set, future requests from this client will include the Client Login<br> |
| token.<br> |
| <br> |
| For a list of service names, see <br> |
| <a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br> |
| For more information on Client Login, see:<br> |
| <a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br> |
| <br> |
| Args:<br> |
| email: str The user's email address or username.<br> |
| password: str The password for the user's account.<br> |
| source: str The name of your application. This can be anything you<br> |
| like but should should give some indication of which app is<br> |
| making the request.<br> |
| service: str The service code for the service you would like to access.<br> |
| For example, 'cp' for contacts, 'cl' for calendar. For a full<br> |
| list see<br> |
| <a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br> |
| If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br> |
| service will usually be filled in for you so you do not need<br> |
| to specify it. For example see BloggerClient,<br> |
| SpreadsheetsClient, etc.<br> |
| account_type: str (optional) The type of account which is being<br> |
| authenticated. This can be either 'GOOGLE' for a Google<br> |
| Account, 'HOSTED' for a Google Apps Account, or the<br> |
| default 'HOSTED_OR_GOOGLE' which will select the Google<br> |
| Apps Account if the same email address is used for both<br> |
| a Google Account and a Google Apps Account.<br> |
| auth_url: str (optional) The URL to which the login request should be<br> |
| sent.<br> |
| captcha_token: str (optional) If a previous login attempt was reponded<br> |
| to with a CAPTCHA challenge, this is the token which<br> |
| identifies the challenge (from the CAPTCHA's URL).<br> |
| captcha_response: str (optional) If a previous login attempt was<br> |
| reponded to with a CAPTCHA challenge, this is the<br> |
| response text which was contained in the challenge.<br> |
| <br> |
| Returns:<br> |
| Generated token, which is also stored in this object.<br> |
| <br> |
| Raises:<br> |
| A RequestError or one of its suclasses: BadAuthentication,<br> |
| BadAuthenticationServiceURL, ClientLoginFailed,<br> |
| ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-Delete"><strong>Delete</strong></a> = delete(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-GetAccessToken"><strong>GetAccessToken</strong></a> = get_access_token(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br> |
| <br> |
| Contacts the Google OAuth server to upgrade a previously authorized<br> |
| request token. Once the request token is upgraded to an access token,<br> |
| the access token may be used to access the user's data.<br> |
| <br> |
| For more details, see the Google Accounts OAuth documentation:<br> |
| <a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br> |
| <br> |
| Args:<br> |
| request_token: An OAuth token which has been authorized by the user.<br> |
| url: (optional) The URL to which the upgrade request should be sent.<br> |
| Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-GetEntry"><strong>GetEntry</strong></a> = get_entry(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-GetFeed"><strong>GetFeed</strong></a> = get_feed(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-GetNext"><strong>GetNext</strong></a> = get_next(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br> |
| <br> |
| When requesting a feed, the number of entries returned is capped at a<br> |
| service specific default limit (often 25 entries). You can specify your<br> |
| own entry-count cap using the max-results URL query parameter. If there<br> |
| are more results than could fit under max-results, the feed will contain<br> |
| a next link. This method performs a GET against this next results URL.<br> |
| <br> |
| Returns:<br> |
| A new feed object containing the next set of entries in this feed.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-GetOAuthToken"><strong>GetOAuthToken</strong></a> = get_oauth_token(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br> |
| <br> |
| Once this client has a request token, the user can authorize the request<br> |
| token by visiting the authorization URL in their browser. After being<br> |
| redirected back to this app at the 'next' URL, this app can then exchange<br> |
| the authorized request token for an access token.<br> |
| <br> |
| For more information see the documentation on Google Accounts with OAuth:<br> |
| <a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br> |
| <br> |
| Args:<br> |
| scopes: list of strings or atom.http_core.Uri objects which specify the<br> |
| URL prefixes which this app will be accessing. For example, to access<br> |
| the Google Calendar API, you would want to use scopes:<br> |
| ['https://www.google.com/calendar/feeds/',<br> |
| '<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br> |
| next: str or atom.http_core.Uri object, The URL which the user's browser<br> |
| should be sent to after they authorize access to their data. This<br> |
| should be a URL in your application which will read the token<br> |
| information from the URL and upgrade the request token to an access<br> |
| token.<br> |
| consumer_key: str This is the identifier for this application which you<br> |
| should have received when you registered your application with Google<br> |
| to use OAuth.<br> |
| consumer_secret: str (optional) The shared secret between your app and<br> |
| Google which provides evidence that this request is coming from you<br> |
| application and not another app. If present, this libraries assumes<br> |
| you want to use an HMAC signature to verify requests. Keep this data<br> |
| a secret.<br> |
| rsa_private_key: str (optional) The RSA private key which is used to<br> |
| generate a digital signature which is checked by Google's server. If<br> |
| present, this library assumes that you want to use an RSA signature<br> |
| to verify requests. Keep this data a secret.<br> |
| url: The URL to which a request for a token should be made. The default<br> |
| is Google's OAuth request token provider.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br> |
| <br> |
| This client will add the API version if it is specified.<br> |
| Subclasses may override this method to add their own request<br> |
| modifications before the request is made.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-Post"><strong>Post</strong></a> = post(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-Request"><strong>Request</strong></a> = request(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br> |
| <br> |
| See also documentation for atom.client.AtomPubClient.request.<br> |
| <br> |
| If a 302 redirect is sent from the server to the client, this client<br> |
| assumes that the redirect is in the form used by the Google Calendar API.<br> |
| The same request URI and method will be used as in the original request,<br> |
| but a gsessionid URL parameter will be added to the request URI with<br> |
| the value provided in the server's 302 redirect response. If the 302<br> |
| redirect is not in the format specified by the Google Calendar API, a<br> |
| RedirectError will be raised containing the body of the server's<br> |
| response.<br> |
| <br> |
| The method calls the client's modify_request method to make any changes<br> |
| required by the client before the request is made. For example, a<br> |
| version 2 client could add a GData-Version: 2 header to the request in<br> |
| its modify_request method.<br> |
| <br> |
| Args:<br> |
| method: str The HTTP verb for this request, usually 'GET', 'POST',<br> |
| 'PUT', or 'DELETE'<br> |
| uri: atom.http_core.Uri, str, or unicode The URL being requested.<br> |
| auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.<br> |
| http_request: (optional) atom.http_core.HttpRequest<br> |
| converter: function which takes the body of the response as its only<br> |
| argument and returns the desired object.<br> |
| desired_class: class descended from atom.core.XmlElement to which a<br> |
| successful response should be converted. If there is no<br> |
| converter function specified (converter=None) then the<br> |
| desired_class will be used in calling the<br> |
| atom.core.parse function. If neither<br> |
| the desired_class nor the converter is specified, an<br> |
| HTTP reponse object will be returned.<br> |
| redirects_remaining: (optional) int, if this number is 0 and the<br> |
| server sends a 302 redirect, the request method<br> |
| will raise an exception. This parameter is used in<br> |
| recursive request calls to avoid an infinite loop.<br> |
| <br> |
| Any additional arguments are passed through to<br> |
| atom.client.AtomPubClient.request.<br> |
| <br> |
| Returns:<br> |
| An HTTP response object (see atom.http_core.HttpResponse for a<br> |
| description of the object's interface) if no converter was<br> |
| specified and no desired_class was specified. If a converter function<br> |
| was provided, the results of calling the converter are returned. If no<br> |
| converter was specified but a desired_class was provided, the response<br> |
| body will be converted to the class using<br> |
| atom.core.parse.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = request_client_login_token(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-RevokeToken"><strong>RevokeToken</strong></a> = revoke_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br> |
| <br> |
| This method can be used for both AuthSub and OAuth tokens (to invalidate<br> |
| a ClientLogin token, the user must change their password).<br> |
| <br> |
| Returns:<br> |
| True if the server responded with a 200.<br> |
| <br> |
| Raises:<br> |
| A RequestError if the server responds with a non-200 status.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-Update"><strong>Update</strong></a> = update(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br> |
| <br> |
| Performs a PUT and converts the response to a new entry object with a<br> |
| matching class to the entry passed in.<br> |
| <br> |
| Args:<br> |
| entry:<br> |
| auth_token:<br> |
| force: boolean stating whether an update should be forced. Defaults to<br> |
| False. Normally, if a change has been made since the passed in<br> |
| entry was obtained, the server will not overwrite the entry since<br> |
| the changes were based on an obsolete version of the entry.<br> |
| Setting force to True will cause the update to silently<br> |
| overwrite whatever version is present.<br> |
| uri: The uri to put to. If provided, this uri is PUT to rather than the<br> |
| inferred uri from the entry's edit link.<br> |
| <br> |
| Returns:<br> |
| A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-UpgradeToken"><strong>UpgradeToken</strong></a> = upgrade_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br> |
| <br> |
| For details on AuthSub, see:<br> |
| <a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br> |
| <br> |
| Args:<br> |
| token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br> |
| (optional) If no token is passed in, the client's auth_token member<br> |
| is used to request the new token. The token object will be modified<br> |
| to contain the new session token string.<br> |
| url: str or atom.http_core.Uri (optional) The URL to which the token<br> |
| upgrade request should be sent. Defaults to:<br> |
| https://www.google.com/accounts/AuthSubSessionToken<br> |
| <br> |
| Returns:<br> |
| The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-batch"><strong>batch</strong></a>(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br> |
| <br> |
| Args:<br> |
| feed: A batch feed containing batch entries, each is an operation.<br> |
| uri: (optional) The uri to which the batch request feed should be POSTed.<br> |
| If none is provided, then the feed's edit link will be used.<br> |
| force: (optional) boolean set to True if you want the batch update to<br> |
| clobber all data. If False, the version in the information in the<br> |
| feed object will cause the server to check to see that no changes<br> |
| intervened between when you fetched the data and when you sent the<br> |
| changes.<br> |
| auth_token: (optional) An object which sets the Authorization HTTP header<br> |
| in its modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br> |
| <br> |
| In order to modify user specific data and read user private data, your<br> |
| application must be authorized by the user. One way to demonstrage<br> |
| authorization is by including a Client Login token in the Authorization<br> |
| HTTP header of all requests. This method requests the Client Login token<br> |
| by sending the user's email address, password, the name of the<br> |
| application, and the service code for the service which will be accessed<br> |
| by the application. If the username and password are correct, the server<br> |
| will respond with the client login code and a new ClientLoginToken<br> |
| object will be set in the client's auth_token member. With the auth_token<br> |
| set, future requests from this client will include the Client Login<br> |
| token.<br> |
| <br> |
| For a list of service names, see <br> |
| <a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br> |
| For more information on Client Login, see:<br> |
| <a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br> |
| <br> |
| Args:<br> |
| email: str The user's email address or username.<br> |
| password: str The password for the user's account.<br> |
| source: str The name of your application. This can be anything you<br> |
| like but should should give some indication of which app is<br> |
| making the request.<br> |
| service: str The service code for the service you would like to access.<br> |
| For example, 'cp' for contacts, 'cl' for calendar. For a full<br> |
| list see<br> |
| <a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br> |
| If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br> |
| service will usually be filled in for you so you do not need<br> |
| to specify it. For example see BloggerClient,<br> |
| SpreadsheetsClient, etc.<br> |
| account_type: str (optional) The type of account which is being<br> |
| authenticated. This can be either 'GOOGLE' for a Google<br> |
| Account, 'HOSTED' for a Google Apps Account, or the<br> |
| default 'HOSTED_OR_GOOGLE' which will select the Google<br> |
| Apps Account if the same email address is used for both<br> |
| a Google Account and a Google Apps Account.<br> |
| auth_url: str (optional) The URL to which the login request should be<br> |
| sent.<br> |
| captcha_token: str (optional) If a previous login attempt was reponded<br> |
| to with a CAPTCHA challenge, this is the token which<br> |
| identifies the challenge (from the CAPTCHA's URL).<br> |
| captcha_response: str (optional) If a previous login attempt was<br> |
| reponded to with a CAPTCHA challenge, this is the<br> |
| response text which was contained in the challenge.<br> |
| <br> |
| Returns:<br> |
| Generated token, which is also stored in this object.<br> |
| <br> |
| Raises:<br> |
| A RequestError or one of its suclasses: BadAuthentication,<br> |
| BadAuthenticationServiceURL, ClientLoginFailed,<br> |
| ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-delete"><strong>delete</strong></a>(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-get_access_token"><strong>get_access_token</strong></a>(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br> |
| <br> |
| Contacts the Google OAuth server to upgrade a previously authorized<br> |
| request token. Once the request token is upgraded to an access token,<br> |
| the access token may be used to access the user's data.<br> |
| <br> |
| For more details, see the Google Accounts OAuth documentation:<br> |
| <a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br> |
| <br> |
| Args:<br> |
| request_token: An OAuth token which has been authorized by the user.<br> |
| url: (optional) The URL to which the upgrade request should be sent.<br> |
| Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-get_entry"><strong>get_entry</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-get_feed"><strong>get_feed</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-get_next"><strong>get_next</strong></a>(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br> |
| <br> |
| When requesting a feed, the number of entries returned is capped at a<br> |
| service specific default limit (often 25 entries). You can specify your<br> |
| own entry-count cap using the max-results URL query parameter. If there<br> |
| are more results than could fit under max-results, the feed will contain<br> |
| a next link. This method performs a GET against this next results URL.<br> |
| <br> |
| Returns:<br> |
| A new feed object containing the next set of entries in this feed.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-get_oauth_token"><strong>get_oauth_token</strong></a>(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br> |
| <br> |
| Once this client has a request token, the user can authorize the request<br> |
| token by visiting the authorization URL in their browser. After being<br> |
| redirected back to this app at the 'next' URL, this app can then exchange<br> |
| the authorized request token for an access token.<br> |
| <br> |
| For more information see the documentation on Google Accounts with OAuth:<br> |
| <a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br> |
| <br> |
| Args:<br> |
| scopes: list of strings or atom.http_core.Uri objects which specify the<br> |
| URL prefixes which this app will be accessing. For example, to access<br> |
| the Google Calendar API, you would want to use scopes:<br> |
| ['https://www.google.com/calendar/feeds/',<br> |
| '<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br> |
| next: str or atom.http_core.Uri object, The URL which the user's browser<br> |
| should be sent to after they authorize access to their data. This<br> |
| should be a URL in your application which will read the token<br> |
| information from the URL and upgrade the request token to an access<br> |
| token.<br> |
| consumer_key: str This is the identifier for this application which you<br> |
| should have received when you registered your application with Google<br> |
| to use OAuth.<br> |
| consumer_secret: str (optional) The shared secret between your app and<br> |
| Google which provides evidence that this request is coming from you<br> |
| application and not another app. If present, this libraries assumes<br> |
| you want to use an HMAC signature to verify requests. Keep this data<br> |
| a secret.<br> |
| rsa_private_key: str (optional) The RSA private key which is used to<br> |
| generate a digital signature which is checked by Google's server. If<br> |
| present, this library assumes that you want to use an RSA signature<br> |
| to verify requests. Keep this data a secret.<br> |
| url: The URL to which a request for a token should be made. The default<br> |
| is Google's OAuth request token provider.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br> |
| <br> |
| This client will add the API version if it is specified.<br> |
| Subclasses may override this method to add their own request<br> |
| modifications before the request is made.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-post"><strong>post</strong></a>(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-request"><strong>request</strong></a>(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br> |
| <br> |
| See also documentation for atom.client.AtomPubClient.request.<br> |
| <br> |
| If a 302 redirect is sent from the server to the client, this client<br> |
| assumes that the redirect is in the form used by the Google Calendar API.<br> |
| The same request URI and method will be used as in the original request,<br> |
| but a gsessionid URL parameter will be added to the request URI with<br> |
| the value provided in the server's 302 redirect response. If the 302<br> |
| redirect is not in the format specified by the Google Calendar API, a<br> |
| RedirectError will be raised containing the body of the server's<br> |
| response.<br> |
| <br> |
| The method calls the client's modify_request method to make any changes<br> |
| required by the client before the request is made. For example, a<br> |
| version 2 client could add a GData-Version: 2 header to the request in<br> |
| its modify_request method.<br> |
| <br> |
| Args:<br> |
| method: str The HTTP verb for this request, usually 'GET', 'POST',<br> |
| 'PUT', or 'DELETE'<br> |
| uri: atom.http_core.Uri, str, or unicode The URL being requested.<br> |
| auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method. Recommended classes include<br> |
| gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br> |
| among others.<br> |
| http_request: (optional) atom.http_core.HttpRequest<br> |
| converter: function which takes the body of the response as its only<br> |
| argument and returns the desired object.<br> |
| desired_class: class descended from atom.core.XmlElement to which a<br> |
| successful response should be converted. If there is no<br> |
| converter function specified (converter=None) then the<br> |
| desired_class will be used in calling the<br> |
| atom.core.parse function. If neither<br> |
| the desired_class nor the converter is specified, an<br> |
| HTTP reponse object will be returned.<br> |
| redirects_remaining: (optional) int, if this number is 0 and the<br> |
| server sends a 302 redirect, the request method<br> |
| will raise an exception. This parameter is used in<br> |
| recursive request calls to avoid an infinite loop.<br> |
| <br> |
| Any additional arguments are passed through to<br> |
| atom.client.AtomPubClient.request.<br> |
| <br> |
| Returns:<br> |
| An HTTP response object (see atom.http_core.HttpResponse for a<br> |
| description of the object's interface) if no converter was<br> |
| specified and no desired_class was specified. If a converter function<br> |
| was provided, the results of calling the converter are returned. If no<br> |
| converter was specified but a desired_class was provided, the response<br> |
| body will be converted to the class using<br> |
| atom.core.parse.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-revoke_token"><strong>revoke_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br> |
| <br> |
| This method can be used for both AuthSub and OAuth tokens (to invalidate<br> |
| a ClientLogin token, the user must change their password).<br> |
| <br> |
| Returns:<br> |
| True if the server responded with a 200.<br> |
| <br> |
| Raises:<br> |
| A RequestError if the server responds with a non-200 status.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-update"><strong>update</strong></a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br> |
| <br> |
| Performs a PUT and converts the response to a new entry object with a<br> |
| matching class to the entry passed in.<br> |
| <br> |
| Args:<br> |
| entry:<br> |
| auth_token:<br> |
| force: boolean stating whether an update should be forced. Defaults to<br> |
| False. Normally, if a change has been made since the passed in<br> |
| entry was obtained, the server will not overwrite the entry since<br> |
| the changes were based on an obsolete version of the entry.<br> |
| Setting force to True will cause the update to silently<br> |
| overwrite whatever version is present.<br> |
| uri: The uri to put to. If provided, this uri is PUT to rather than the<br> |
| inferred uri from the entry's edit link.<br> |
| <br> |
| Returns:<br> |
| A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br> |
| <br> |
| For details on AuthSub, see:<br> |
| <a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br> |
| <br> |
| Args:<br> |
| token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br> |
| (optional) If no token is passed in, the client's auth_token member<br> |
| is used to request the new token. The token object will be modified<br> |
| to contain the new session token string.<br> |
| url: str or atom.http_core.Uri (optional) The URL to which the token<br> |
| upgrade request should be sent. Defaults to:<br> |
| https://www.google.com/accounts/AuthSubSessionToken<br> |
| <br> |
| Returns:<br> |
| The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br> |
| <dl><dt><strong>alt_auth_service</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br> |
| <dl><dt><a name="MultiDomainProvisioningClient-Get"><strong>Get</strong></a> = get(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-Put"><strong>Put</strong></a> = put(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-get"><strong>get</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl> |
| |
| <dl><dt><a name="MultiDomainProvisioningClient-put"><strong>put</strong></a>(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl> |
| |
| <hr> |
| Data descriptors inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| <hr> |
| Data and other attributes inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br> |
| <dl><dt><strong>auth_token</strong> = None</dl> |
| |
| <dl><dt><strong>xoauth_requestor_id</strong> = None</dl> |
| |
| </td></tr></table></td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#55aa55"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td> |
| <td width="100%"><strong>MULTIDOMAIN_ALIAS_FEED</strong> = 'alias'<br> |
| <strong>MULTIDOMAIN_URI_TEMPLATE</strong> = '/a/feeds/%s/%s/%s'<br> |
| <strong>MULTIDOMAIN_USER_FEED</strong> = 'user'<br> |
| <strong>MULTIDOMAIN_USER_RENAME_URI_TEMPLATE</strong> = '/a/feeds/user/userEmail/%s/%s/%s'<br> |
| <strong>__author__</strong> = 'Claudio Cherubino <ccherubino@google.com>'</td></tr></table><p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#7799ee"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr> |
| |
| <tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td> |
| <td width="100%">Claudio Cherubino <ccherubino@google.com></td></tr></table> |
| </body></html> |