blob: b019d535bff459cf7887b7ac6d0544cdd70c7a62 [file] [log] [blame]
Joe Gregorio30dfdc32010-12-09 16:34:22 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.oauth</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.oauth</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregorioa8451672011-09-15 09:53:21 -040011><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/oauth.py">/usr/local/google/home/jcgregorio/projects/apiclient/apiclient/oauth.py</a></font></td></tr></table>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050012 <p><tt>Utilities&nbsp;for&nbsp;OAuth.<br>
13&nbsp;<br>
14Utilities&nbsp;for&nbsp;making&nbsp;it&nbsp;easier&nbsp;to&nbsp;work&nbsp;with&nbsp;OAuth.</tt></p>
15<p>
16<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
17<tr bgcolor="#aa55cc">
18<td colspan=3 valign=bottom>&nbsp;<br>
19<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
20
21<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
22<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="copy.html">copy</a><br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -050023<a href="httplib2.html">httplib2</a><br>
24</td><td width="25%" valign=top><a href="logging.html">logging</a><br>
25<a href="oauth2.html">oauth2</a><br>
26</td><td width="25%" valign=top><a href="simplejson.html">simplejson</a><br>
27<a href="urllib.html">urllib</a><br>
28</td><td width="25%" valign=top><a href="urlparse.html">urlparse</a><br>
Joe Gregorio6e537032011-02-09 23:04:26 -050029</td></tr></table></td></tr></table><p>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050030<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
31<tr bgcolor="#ee77aa">
32<td colspan=3 valign=bottom>&nbsp;<br>
33<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
34
35<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
36<td width="100%"><dl>
37<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
38</font></dt><dd>
39<dl>
40<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#Credentials">Credentials</a>
41</font></dt><dd>
42<dl>
43<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -040044</font></dt><dt><font face="helvetica, arial"><a href="apiclient.oauth.html#TwoLeggedOAuthCredentials">TwoLeggedOAuthCredentials</a>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050045</font></dt></dl>
46</dd>
Joe Gregorio6e537032011-02-09 23:04:26 -050047<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#Flow">Flow</a>
48</font></dt><dd>
49<dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050050<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a>
51</font></dt></dl>
52</dd>
Joe Gregoriofffa7d72011-02-18 17:20:39 -050053<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#Storage">Storage</a>
54</font></dt></dl>
Joe Gregorio6e537032011-02-09 23:04:26 -050055</dd>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050056<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
57</font></dt><dd>
58<dl>
59<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#Error">Error</a>
60</font></dt><dd>
61<dl>
Joe Gregoriofffa7d72011-02-18 17:20:39 -050062<dt><font face="helvetica, arial"><a href="apiclient.oauth.html#CredentialsInvalidError">CredentialsInvalidError</a>
63</font></dt><dt><font face="helvetica, arial"><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a>
Joe Gregorio30dfdc32010-12-09 16:34:22 -050064</font></dt><dt><font face="helvetica, arial"><a href="apiclient.oauth.html#RequestError">RequestError</a>
65</font></dt></dl>
66</dd>
67</dl>
68</dd>
69</dl>
70 <p>
71<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
72<tr bgcolor="#ffc8d8">
73<td colspan=3 valign=bottom>&nbsp;<br>
74<font color="#000000" face="helvetica, arial"><a name="Credentials">class <strong>Credentials</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
75
76<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
77<td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;all&nbsp;<a href="#Credentials">Credentials</a>&nbsp;objects.<br>
78&nbsp;<br>
79Subclasses&nbsp;must&nbsp;define&nbsp;an&nbsp;<a href="#Credentials-authorize">authorize</a>()&nbsp;method<br>
80that&nbsp;applies&nbsp;the&nbsp;credentials&nbsp;to&nbsp;an&nbsp;HTTP&nbsp;transport.<br>&nbsp;</tt></td></tr>
81<tr><td>&nbsp;</td>
82<td width="100%">Methods defined here:<br>
83<dl><dt><a name="Credentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Take&nbsp;an&nbsp;httplib2.Http&nbsp;instance&nbsp;(or&nbsp;equivalent)&nbsp;and<br>
84authorizes&nbsp;it&nbsp;for&nbsp;the&nbsp;set&nbsp;of&nbsp;credentials,&nbsp;usually&nbsp;by<br>
85replacing&nbsp;http.request()&nbsp;with&nbsp;a&nbsp;method&nbsp;that&nbsp;adds&nbsp;in<br>
86the&nbsp;appropriate&nbsp;headers&nbsp;and&nbsp;then&nbsp;delegates&nbsp;to&nbsp;the&nbsp;original<br>
87Http.request()&nbsp;method.</tt></dd></dl>
88
89<hr>
90Data descriptors defined here:<br>
91<dl><dt><strong>__dict__</strong></dt>
92<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
93</dl>
94<dl><dt><strong>__weakref__</strong></dt>
95<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
96</dl>
97</td></tr></table> <p>
98<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
99<tr bgcolor="#ffc8d8">
100<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500101<font color="#000000" face="helvetica, arial"><a name="CredentialsInvalidError">class <strong>CredentialsInvalidError</strong></a>(<a href="apiclient.oauth.html#Error">Error</a>)</font></td></tr>
102
103<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
104<td width="100%"><dl><dt>Method resolution order:</dt>
105<dd><a href="apiclient.oauth.html#CredentialsInvalidError">CredentialsInvalidError</a></dd>
106<dd><a href="apiclient.oauth.html#Error">Error</a></dd>
107<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
108<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
109<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
110</dl>
111<hr>
112Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:<br>
113<dl><dt><strong>__weakref__</strong></dt>
114<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
115</dl>
116<hr>
117Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
Joe Gregorio90e7ec22011-07-06 10:09:20 -0400118<dl><dt><a name="CredentialsInvalidError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500119
120<hr>
121Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
122<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#CredentialsInvalidError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
123
124<hr>
125Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
126<dl><dt><a name="CredentialsInvalidError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
127
128<dl><dt><a name="CredentialsInvalidError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
129
130<dl><dt><a name="CredentialsInvalidError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
131
132<dl><dt><a name="CredentialsInvalidError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
133&nbsp;<br>
134Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
135
136<dl><dt><a name="CredentialsInvalidError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
137
138<dl><dt><a name="CredentialsInvalidError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
139
140<dl><dt><a name="CredentialsInvalidError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
141
142<dl><dt><a name="CredentialsInvalidError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
143
144<dl><dt><a name="CredentialsInvalidError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#CredentialsInvalidError-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
145
146<dl><dt><a name="CredentialsInvalidError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
147
148<hr>
149Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
150<dl><dt><strong>__dict__</strong></dt>
151</dl>
152<dl><dt><strong>args</strong></dt>
153</dl>
154<dl><dt><strong>message</strong></dt>
155</dl>
156</td></tr></table> <p>
157<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
158<tr bgcolor="#ffc8d8">
159<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500160<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
161
162<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
163<td colspan=2><tt>Base&nbsp;error&nbsp;for&nbsp;this&nbsp;module.<br>&nbsp;</tt></td></tr>
164<tr><td>&nbsp;</td>
165<td width="100%"><dl><dt>Method resolution order:</dt>
166<dd><a href="apiclient.oauth.html#Error">Error</a></dd>
167<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
168<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
169<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
170</dl>
171<hr>
172Data descriptors defined here:<br>
173<dl><dt><strong>__weakref__</strong></dt>
174<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
175</dl>
176<hr>
177Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
Joe Gregorio90e7ec22011-07-06 10:09:20 -0400178<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500179
180<hr>
181Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
182<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#Error-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
183
184<hr>
185Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
186<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
187
188<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
189
190<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
191
192<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
193&nbsp;<br>
194Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
195
196<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
197
198<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
199
200<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
201
202<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
203
204<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
205
206<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
207
208<hr>
209Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
210<dl><dt><strong>__dict__</strong></dt>
211</dl>
212<dl><dt><strong>args</strong></dt>
213</dl>
214<dl><dt><strong>message</strong></dt>
215</dl>
216</td></tr></table> <p>
217<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
218<tr bgcolor="#ffc8d8">
219<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio6e537032011-02-09 23:04:26 -0500220<font color="#000000" face="helvetica, arial"><a name="Flow">class <strong>Flow</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
221
222<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
223<td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;all&nbsp;<a href="#Flow">Flow</a>&nbsp;objects.<br>&nbsp;</tt></td></tr>
224<tr><td>&nbsp;</td>
225<td width="100%">Data descriptors defined here:<br>
226<dl><dt><strong>__dict__</strong></dt>
227<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
228</dl>
229<dl><dt><strong>__weakref__</strong></dt>
230<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
231</dl>
232</td></tr></table> <p>
233<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
234<tr bgcolor="#ffc8d8">
235<td colspan=3 valign=bottom>&nbsp;<br>
236<font color="#000000" face="helvetica, arial"><a name="FlowThreeLegged">class <strong>FlowThreeLegged</strong></a>(<a href="apiclient.oauth.html#Flow">Flow</a>)</font></td></tr>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500237
238<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
239<td colspan=2><tt>Does&nbsp;the&nbsp;Three&nbsp;Legged&nbsp;Dance&nbsp;for&nbsp;OAuth&nbsp;1.0a.<br>&nbsp;</tt></td></tr>
240<tr><td>&nbsp;</td>
Joe Gregorio6e537032011-02-09 23:04:26 -0500241<td width="100%"><dl><dt>Method resolution order:</dt>
242<dd><a href="apiclient.oauth.html#FlowThreeLegged">FlowThreeLegged</a></dd>
243<dd><a href="apiclient.oauth.html#Flow">Flow</a></dd>
244<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
245</dl>
246<hr>
247Methods defined here:<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500248<dl><dt><a name="FlowThreeLegged-__init__"><strong>__init__</strong></a>(self, discovery, consumer_key, consumer_secret, user_agent, **kwargs)</dt><dd><tt>discovery&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;Section&nbsp;of&nbsp;the&nbsp;API&nbsp;discovery&nbsp;document&nbsp;that&nbsp;describes<br>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;OAuth&nbsp;endpoints.<br>
250consumer_key&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;OAuth&nbsp;consumer&nbsp;key<br>
251consumer_secret&nbsp;-&nbsp;OAuth&nbsp;consumer&nbsp;secret<br>
252user_agent&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;The&nbsp;HTTP&nbsp;User-Agent&nbsp;that&nbsp;identifies&nbsp;the&nbsp;application.<br>
253**kwargs&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;The&nbsp;keyword&nbsp;arguments&nbsp;are&nbsp;all&nbsp;optional&nbsp;and&nbsp;required<br>
254&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;parameters&nbsp;for&nbsp;the&nbsp;OAuth&nbsp;calls.</tt></dd></dl>
255
256<dl><dt><a name="FlowThreeLegged-step1_get_authorize_url"><strong>step1_get_authorize_url</strong></a>(self, oauth_callback<font color="#909090">='oob'</font>)</dt><dd><tt>Returns&nbsp;a&nbsp;URI&nbsp;to&nbsp;redirect&nbsp;to&nbsp;the&nbsp;provider.<br>
257&nbsp;<br>
258oauth_callback&nbsp;-&nbsp;Either&nbsp;the&nbsp;string&nbsp;'oob'&nbsp;for&nbsp;a&nbsp;non-web-based&nbsp;application,<br>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;a&nbsp;URI&nbsp;that&nbsp;handles&nbsp;the&nbsp;callback&nbsp;from&nbsp;the&nbsp;authorization<br>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;server.<br>
261&nbsp;<br>
262If&nbsp;oauth_callback&nbsp;is&nbsp;'oob'&nbsp;then&nbsp;pass&nbsp;in&nbsp;the<br>
263generated&nbsp;verification&nbsp;code&nbsp;to&nbsp;step2_exchange,<br>
264otherwise&nbsp;pass&nbsp;in&nbsp;the&nbsp;query&nbsp;parameters&nbsp;received<br>
265at&nbsp;the&nbsp;callback&nbsp;uri&nbsp;to&nbsp;step2_exchange.</tt></dd></dl>
266
267<dl><dt><a name="FlowThreeLegged-step2_exchange"><strong>step2_exchange</strong></a>(self, verifier)</dt><dd><tt>Exhanges&nbsp;an&nbsp;authorized&nbsp;request&nbsp;token<br>
268for&nbsp;<a href="#OAuthCredentials">OAuthCredentials</a>.<br>
269&nbsp;<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400270Args:<br>
271&nbsp;&nbsp;verifier:&nbsp;string,&nbsp;dict&nbsp;-&nbsp;either&nbsp;the&nbsp;verifier&nbsp;token,&nbsp;or&nbsp;a&nbsp;dictionary<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500272&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;the&nbsp;query&nbsp;parameters&nbsp;to&nbsp;the&nbsp;callback,&nbsp;which&nbsp;contains<br>
Joe Gregorio4258d6b2011-03-18 10:20:16 -0400273&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;oauth_verifier.<br>
274Returns:<br>
275&nbsp;&nbsp;&nbsp;The&nbsp;<a href="#Credentials">Credentials</a>&nbsp;<a href="__builtin__.html#object">object</a>.</tt></dd></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500276
277<hr>
Joe Gregorio6e537032011-02-09 23:04:26 -0500278Data descriptors inherited from <a href="apiclient.oauth.html#Flow">Flow</a>:<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500279<dl><dt><strong>__dict__</strong></dt>
280<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
281</dl>
282<dl><dt><strong>__weakref__</strong></dt>
283<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
284</dl>
285</td></tr></table> <p>
286<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
287<tr bgcolor="#ffc8d8">
288<td colspan=3 valign=bottom>&nbsp;<br>
289<font color="#000000" face="helvetica, arial"><a name="MissingParameter">class <strong>MissingParameter</strong></a>(<a href="apiclient.oauth.html#Error">Error</a>)</font></td></tr>
290
291<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
292<td width="100%"><dl><dt>Method resolution order:</dt>
293<dd><a href="apiclient.oauth.html#MissingParameter">MissingParameter</a></dd>
294<dd><a href="apiclient.oauth.html#Error">Error</a></dd>
295<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
296<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
297<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
298</dl>
299<hr>
300Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:<br>
301<dl><dt><strong>__weakref__</strong></dt>
302<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
303</dl>
304<hr>
305Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
Joe Gregorio90e7ec22011-07-06 10:09:20 -0400306<dl><dt><a name="MissingParameter-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500307
308<hr>
309Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
310<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#MissingParameter-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
311
312<hr>
313Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
314<dl><dt><a name="MissingParameter-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
315
316<dl><dt><a name="MissingParameter-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
317
318<dl><dt><a name="MissingParameter-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
319
320<dl><dt><a name="MissingParameter-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
321&nbsp;<br>
322Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
323
324<dl><dt><a name="MissingParameter-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
325
326<dl><dt><a name="MissingParameter-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
327
328<dl><dt><a name="MissingParameter-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
329
330<dl><dt><a name="MissingParameter-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
331
332<dl><dt><a name="MissingParameter-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#MissingParameter-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
333
334<dl><dt><a name="MissingParameter-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
335
336<hr>
337Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
338<dl><dt><strong>__dict__</strong></dt>
339</dl>
340<dl><dt><strong>args</strong></dt>
341</dl>
342<dl><dt><strong>message</strong></dt>
343</dl>
344</td></tr></table> <p>
345<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
346<tr bgcolor="#ffc8d8">
347<td colspan=3 valign=bottom>&nbsp;<br>
348<font color="#000000" face="helvetica, arial"><a name="OAuthCredentials">class <strong>OAuthCredentials</strong></a>(<a href="apiclient.oauth.html#Credentials">Credentials</a>)</font></td></tr>
349
350<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
351<td colspan=2><tt><a href="#Credentials">Credentials</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;for&nbsp;OAuth&nbsp;1.0a<br>&nbsp;</tt></td></tr>
352<tr><td>&nbsp;</td>
353<td width="100%"><dl><dt>Method resolution order:</dt>
354<dd><a href="apiclient.oauth.html#OAuthCredentials">OAuthCredentials</a></dd>
355<dd><a href="apiclient.oauth.html#Credentials">Credentials</a></dd>
356<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
357</dl>
358<hr>
359Methods defined here:<br>
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500360<dl><dt><a name="OAuthCredentials-__getstate__"><strong>__getstate__</strong></a>(self)</dt><dd><tt>Trim&nbsp;the&nbsp;state&nbsp;down&nbsp;to&nbsp;something&nbsp;that&nbsp;can&nbsp;be&nbsp;pickled.</tt></dd></dl>
361
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500362<dl><dt><a name="OAuthCredentials-__init__"><strong>__init__</strong></a>(self, consumer, token, user_agent)</dt><dd><tt>consumer&nbsp;&nbsp;&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;oauth.Consumer.<br>
363token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;oauth.Token&nbsp;constructed&nbsp;with<br>
364&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;access&nbsp;token&nbsp;and&nbsp;secret.<br>
365user_agent&nbsp;-&nbsp;The&nbsp;HTTP&nbsp;User-Agent&nbsp;to&nbsp;provide&nbsp;for&nbsp;this&nbsp;application.</tt></dd></dl>
366
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500367<dl><dt><a name="OAuthCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute&nbsp;the&nbsp;state&nbsp;of&nbsp;the&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;from&nbsp;being&nbsp;pickled.</tt></dd></dl>
368
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400369<dl><dt><a name="OAuthCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize&nbsp;an&nbsp;httplib2.Http&nbsp;instance&nbsp;with&nbsp;these&nbsp;<a href="#Credentials">Credentials</a><br>
370&nbsp;<br>
371Args:<br>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500372&nbsp;&nbsp;&nbsp;http&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;httplib2.Http<br>
373&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;something&nbsp;that&nbsp;acts&nbsp;like&nbsp;it.<br>
374&nbsp;<br>
375Returns:<br>
376&nbsp;&nbsp;&nbsp;A&nbsp;modified&nbsp;instance&nbsp;of&nbsp;http&nbsp;that&nbsp;was&nbsp;passed&nbsp;in.<br>
377&nbsp;<br>
378Example:<br>
379&nbsp;<br>
380&nbsp;&nbsp;h&nbsp;=&nbsp;httplib2.Http()<br>
381&nbsp;&nbsp;h&nbsp;=&nbsp;credentials.<a href="#OAuthCredentials-authorize">authorize</a>(h)<br>
382&nbsp;<br>
383You&nbsp;can't&nbsp;create&nbsp;a&nbsp;new&nbsp;OAuth<br>
384subclass&nbsp;of&nbsp;httplib2.Authenication&nbsp;because<br>
385it&nbsp;never&nbsp;gets&nbsp;passed&nbsp;the&nbsp;absolute&nbsp;URI,&nbsp;which&nbsp;is<br>
386needed&nbsp;for&nbsp;signing.&nbsp;So&nbsp;instead&nbsp;we&nbsp;have&nbsp;to&nbsp;overload<br>
387'request'&nbsp;with&nbsp;a&nbsp;closure&nbsp;that&nbsp;adds&nbsp;in&nbsp;the<br>
388Authorization&nbsp;header&nbsp;and&nbsp;then&nbsp;calls&nbsp;the&nbsp;original&nbsp;version<br>
389of&nbsp;'request()'.</tt></dd></dl>
390
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500391<dl><dt><a name="OAuthCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set&nbsp;the&nbsp;storage&nbsp;for&nbsp;the&nbsp;credential.<br>
392&nbsp;<br>
393Args:<br>
394&nbsp;&nbsp;store:&nbsp;callable,&nbsp;a&nbsp;callable&nbsp;that&nbsp;when&nbsp;passed&nbsp;a&nbsp;Credential<br>
395&nbsp;&nbsp;&nbsp;&nbsp;will&nbsp;store&nbsp;the&nbsp;credential&nbsp;back&nbsp;to&nbsp;where&nbsp;it&nbsp;came&nbsp;from.<br>
396&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;is&nbsp;needed&nbsp;to&nbsp;store&nbsp;the&nbsp;latest&nbsp;access_token&nbsp;if&nbsp;it<br>
397&nbsp;&nbsp;&nbsp;&nbsp;has&nbsp;been&nbsp;revoked.</tt></dd></dl>
398
399<hr>
400Data descriptors defined here:<br>
401<dl><dt><strong>invalid</strong></dt>
402<dd><tt>True&nbsp;if&nbsp;the&nbsp;credentials&nbsp;are&nbsp;invalid,&nbsp;such&nbsp;as&nbsp;being&nbsp;revoked.</tt></dd>
403</dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500404<hr>
405Data descriptors inherited from <a href="apiclient.oauth.html#Credentials">Credentials</a>:<br>
406<dl><dt><strong>__dict__</strong></dt>
407<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
408</dl>
409<dl><dt><strong>__weakref__</strong></dt>
410<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
411</dl>
412</td></tr></table> <p>
413<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
414<tr bgcolor="#ffc8d8">
415<td colspan=3 valign=bottom>&nbsp;<br>
416<font color="#000000" face="helvetica, arial"><a name="RequestError">class <strong>RequestError</strong></a>(<a href="apiclient.oauth.html#Error">Error</a>)</font></td></tr>
417
418<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
419<td colspan=2><tt><a href="#Error">Error</a>&nbsp;occurred&nbsp;during&nbsp;request.<br>&nbsp;</tt></td></tr>
420<tr><td>&nbsp;</td>
421<td width="100%"><dl><dt>Method resolution order:</dt>
422<dd><a href="apiclient.oauth.html#RequestError">RequestError</a></dd>
423<dd><a href="apiclient.oauth.html#Error">Error</a></dd>
424<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
425<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
426<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
427</dl>
428<hr>
429Data descriptors inherited from <a href="apiclient.oauth.html#Error">Error</a>:<br>
430<dl><dt><strong>__weakref__</strong></dt>
431<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
432</dl>
433<hr>
434Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
Joe Gregorio90e7ec22011-07-06 10:09:20 -0400435<dl><dt><a name="RequestError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500436
437<hr>
438Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
439<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#RequestError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
440
441<hr>
442Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
443<dl><dt><a name="RequestError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
444
445<dl><dt><a name="RequestError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
446
447<dl><dt><a name="RequestError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
448
449<dl><dt><a name="RequestError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
450&nbsp;<br>
451Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
452
453<dl><dt><a name="RequestError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
454
455<dl><dt><a name="RequestError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
456
457<dl><dt><a name="RequestError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
458
459<dl><dt><a name="RequestError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
460
461<dl><dt><a name="RequestError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#RequestError-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
462
463<dl><dt><a name="RequestError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
464
465<hr>
466Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
467<dl><dt><strong>__dict__</strong></dt>
468</dl>
469<dl><dt><strong>args</strong></dt>
470</dl>
471<dl><dt><strong>message</strong></dt>
472</dl>
Joe Gregoriofffa7d72011-02-18 17:20:39 -0500473</td></tr></table> <p>
474<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
475<tr bgcolor="#ffc8d8">
476<td colspan=3 valign=bottom>&nbsp;<br>
477<font color="#000000" face="helvetica, arial"><a name="Storage">class <strong>Storage</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
478
479<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
480<td colspan=2><tt>Base&nbsp;class&nbsp;for&nbsp;all&nbsp;<a href="#Storage">Storage</a>&nbsp;objects.<br>
481&nbsp;<br>
482Store&nbsp;and&nbsp;retrieve&nbsp;a&nbsp;single&nbsp;credential.<br>&nbsp;</tt></td></tr>
483<tr><td>&nbsp;</td>
484<td width="100%">Methods defined here:<br>
485<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;credential.<br>
486&nbsp;<br>
487Returns:<br>
488&nbsp;&nbsp;apiclient.oauth.<a href="#Credentials">Credentials</a></tt></dd></dl>
489
490<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;credential.<br>
491&nbsp;<br>
492Args:<br>
493&nbsp;&nbsp;credentials:&nbsp;<a href="#Credentials">Credentials</a>,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
494
495<hr>
496Data descriptors defined here:<br>
497<dl><dt><strong>__dict__</strong></dt>
498<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
499</dl>
500<dl><dt><strong>__weakref__</strong></dt>
501<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
502</dl>
Joe Gregoriob9e63ff2011-06-30 12:38:10 -0400503</td></tr></table> <p>
504<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
505<tr bgcolor="#ffc8d8">
506<td colspan=3 valign=bottom>&nbsp;<br>
507<font color="#000000" face="helvetica, arial"><a name="TwoLeggedOAuthCredentials">class <strong>TwoLeggedOAuthCredentials</strong></a>(<a href="apiclient.oauth.html#Credentials">Credentials</a>)</font></td></tr>
508
509<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
510<td colspan=2><tt>Two&nbsp;Legged&nbsp;<a href="#Credentials">Credentials</a>&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;for&nbsp;OAuth&nbsp;1.0a.<br>
511&nbsp;<br>
512The&nbsp;Two&nbsp;Legged&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;is&nbsp;created&nbsp;directly,&nbsp;not&nbsp;from&nbsp;a&nbsp;flow.&nbsp;&nbsp;Once&nbsp;you<br>
513authorize&nbsp;and&nbsp;httplib2.Http&nbsp;instance&nbsp;you&nbsp;can&nbsp;change&nbsp;the&nbsp;requestor&nbsp;and&nbsp;that<br>
514change&nbsp;will&nbsp;propogate&nbsp;to&nbsp;the&nbsp;authorized&nbsp;httplib2.Http&nbsp;instance.&nbsp;For&nbsp;example:<br>
515&nbsp;<br>
516&nbsp;&nbsp;http&nbsp;=&nbsp;httplib2.Http()<br>
517&nbsp;&nbsp;http&nbsp;=&nbsp;credentials.<a href="#TwoLeggedOAuthCredentials-authorize">authorize</a>(http)<br>
518&nbsp;<br>
519&nbsp;&nbsp;credentials.requestor&nbsp;=&nbsp;'foo@example.info'<br>
520&nbsp;&nbsp;http.request(...)<br>
521&nbsp;&nbsp;credentials.requestor&nbsp;=&nbsp;'bar@example.info'<br>
522&nbsp;&nbsp;http.request(...)<br>&nbsp;</tt></td></tr>
523<tr><td>&nbsp;</td>
524<td width="100%"><dl><dt>Method resolution order:</dt>
525<dd><a href="apiclient.oauth.html#TwoLeggedOAuthCredentials">TwoLeggedOAuthCredentials</a></dd>
526<dd><a href="apiclient.oauth.html#Credentials">Credentials</a></dd>
527<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
528</dl>
529<hr>
530Methods defined here:<br>
531<dl><dt><a name="TwoLeggedOAuthCredentials-__getstate__"><strong>__getstate__</strong></a>(self)</dt><dd><tt>Trim&nbsp;the&nbsp;state&nbsp;down&nbsp;to&nbsp;something&nbsp;that&nbsp;can&nbsp;be&nbsp;pickled.</tt></dd></dl>
532
533<dl><dt><a name="TwoLeggedOAuthCredentials-__init__"><strong>__init__</strong></a>(self, consumer_key, consumer_secret, user_agent)</dt><dd><tt>Args:<br>
534&nbsp;&nbsp;consumer_key:&nbsp;string,&nbsp;An&nbsp;OAuth&nbsp;1.0&nbsp;consumer&nbsp;key<br>
535&nbsp;&nbsp;consumer_secret:&nbsp;string,&nbsp;An&nbsp;OAuth&nbsp;1.0&nbsp;consumer&nbsp;secret<br>
536&nbsp;&nbsp;user_agent:&nbsp;string,&nbsp;The&nbsp;HTTP&nbsp;User-Agent&nbsp;to&nbsp;provide&nbsp;for&nbsp;this&nbsp;application.</tt></dd></dl>
537
538<dl><dt><a name="TwoLeggedOAuthCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute&nbsp;the&nbsp;state&nbsp;of&nbsp;the&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;from&nbsp;being&nbsp;pickled.</tt></dd></dl>
539
540<dl><dt><a name="TwoLeggedOAuthCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize&nbsp;an&nbsp;httplib2.Http&nbsp;instance&nbsp;with&nbsp;these&nbsp;<a href="#Credentials">Credentials</a><br>
541&nbsp;<br>
542Args:<br>
543&nbsp;&nbsp;&nbsp;http&nbsp;-&nbsp;An&nbsp;instance&nbsp;of&nbsp;httplib2.Http<br>
544&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;something&nbsp;that&nbsp;acts&nbsp;like&nbsp;it.<br>
545&nbsp;<br>
546Returns:<br>
547&nbsp;&nbsp;&nbsp;A&nbsp;modified&nbsp;instance&nbsp;of&nbsp;http&nbsp;that&nbsp;was&nbsp;passed&nbsp;in.<br>
548&nbsp;<br>
549Example:<br>
550&nbsp;<br>
551&nbsp;&nbsp;h&nbsp;=&nbsp;httplib2.Http()<br>
552&nbsp;&nbsp;h&nbsp;=&nbsp;credentials.<a href="#TwoLeggedOAuthCredentials-authorize">authorize</a>(h)<br>
553&nbsp;<br>
554You&nbsp;can't&nbsp;create&nbsp;a&nbsp;new&nbsp;OAuth<br>
555subclass&nbsp;of&nbsp;httplib2.Authenication&nbsp;because<br>
556it&nbsp;never&nbsp;gets&nbsp;passed&nbsp;the&nbsp;absolute&nbsp;URI,&nbsp;which&nbsp;is<br>
557needed&nbsp;for&nbsp;signing.&nbsp;So&nbsp;instead&nbsp;we&nbsp;have&nbsp;to&nbsp;overload<br>
558'request'&nbsp;with&nbsp;a&nbsp;closure&nbsp;that&nbsp;adds&nbsp;in&nbsp;the<br>
559Authorization&nbsp;header&nbsp;and&nbsp;then&nbsp;calls&nbsp;the&nbsp;original&nbsp;version<br>
560of&nbsp;'request()'.</tt></dd></dl>
561
562<dl><dt><a name="TwoLeggedOAuthCredentials-getrequestor"><strong>getrequestor</strong></a>(self)</dt></dl>
563
564<dl><dt><a name="TwoLeggedOAuthCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set&nbsp;the&nbsp;storage&nbsp;for&nbsp;the&nbsp;credential.<br>
565&nbsp;<br>
566Args:<br>
567&nbsp;&nbsp;store:&nbsp;callable,&nbsp;a&nbsp;callable&nbsp;that&nbsp;when&nbsp;passed&nbsp;a&nbsp;Credential<br>
568&nbsp;&nbsp;&nbsp;&nbsp;will&nbsp;store&nbsp;the&nbsp;credential&nbsp;back&nbsp;to&nbsp;where&nbsp;it&nbsp;came&nbsp;from.<br>
569&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;is&nbsp;needed&nbsp;to&nbsp;store&nbsp;the&nbsp;latest&nbsp;access_token&nbsp;if&nbsp;it<br>
570&nbsp;&nbsp;&nbsp;&nbsp;has&nbsp;been&nbsp;revoked.</tt></dd></dl>
571
572<dl><dt><a name="TwoLeggedOAuthCredentials-setrequestor"><strong>setrequestor</strong></a>(self, email)</dt></dl>
573
574<hr>
575Data descriptors defined here:<br>
576<dl><dt><strong>invalid</strong></dt>
577<dd><tt>True&nbsp;if&nbsp;the&nbsp;credentials&nbsp;are&nbsp;invalid,&nbsp;such&nbsp;as&nbsp;being&nbsp;revoked.<br>
578&nbsp;<br>
579Always&nbsp;returns&nbsp;False&nbsp;for&nbsp;Two&nbsp;Legged&nbsp;Credentials.</tt></dd>
580</dl>
581<dl><dt><strong>requestor</strong></dt>
582<dd><tt>The&nbsp;email&nbsp;address&nbsp;of&nbsp;the&nbsp;user&nbsp;to&nbsp;act&nbsp;on&nbsp;behalf&nbsp;of</tt></dd>
583</dl>
584<hr>
585Data descriptors inherited from <a href="apiclient.oauth.html#Credentials">Credentials</a>:<br>
586<dl><dt><strong>__dict__</strong></dt>
587<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
588</dl>
589<dl><dt><strong>__weakref__</strong></dt>
590<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
591</dl>
Joe Gregorio30dfdc32010-12-09 16:34:22 -0500592</td></tr></table></td></tr></table><p>
593<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
594<tr bgcolor="#55aa55">
595<td colspan=3 valign=bottom>&nbsp;<br>
596<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
597
598<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
599<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
600<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
601<tr bgcolor="#7799ee">
602<td colspan=3 valign=bottom>&nbsp;<br>
603<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
604
605<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
606<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
607</body></html>