blob: cc5ea82ff54cf9a924c81137f4018a62f7afd50f [file] [log] [blame]
Joe Gregorio6e537032011-02-09 23:04:26 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module oauth2client.file</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="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.file</strong></big></big></font></td
10><td align=right valign=bottom
Joe Gregorio351b1492011-05-08 23:32:46 -070011><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/file.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/file.py</a></font></td></tr></table>
Joe Gregorio6e537032011-02-09 23:04:26 -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&nbsp;2.0<br>
15credentials.</tt></p>
16<p>
17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
18<tr bgcolor="#aa55cc">
19<td colspan=3 valign=bottom>&nbsp;<br>
20<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
21
22<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="pickle.html">pickle</a><br>
Joe Gregorioad258e22011-02-22 22:53:30 -050024</td><td width="25%" valign=top><a href="threading.html">threading</a><br>
25</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
Joe Gregorio6e537032011-02-09 23:04:26 -050026<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
27<tr bgcolor="#ee77aa">
28<td colspan=3 valign=bottom>&nbsp;<br>
29<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
30
31<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
32<td width="100%"><dl>
Joe Gregorio3b79fa82011-02-17 11:47:17 -050033<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
Joe Gregorio6e537032011-02-09 23:04:26 -050034</font></dt><dd>
35<dl>
36<dt><font face="helvetica, arial"><a href="oauth2client.file.html#Storage">Storage</a>
37</font></dt></dl>
38</dd>
39</dl>
40 <p>
41<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
42<tr bgcolor="#ffc8d8">
43<td colspan=3 valign=bottom>&nbsp;<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -050044<font color="#000000" face="helvetica, arial"><a name="Storage">class <strong>Storage</strong></a>(<a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>)</font></td></tr>
Joe Gregorio6e537032011-02-09 23:04:26 -050045
46<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
47<td colspan=2><tt>Store&nbsp;and&nbsp;retrieve&nbsp;a&nbsp;single&nbsp;credential&nbsp;to&nbsp;and&nbsp;from&nbsp;a&nbsp;file.<br>&nbsp;</tt></td></tr>
48<tr><td>&nbsp;</td>
Joe Gregorio3b79fa82011-02-17 11:47:17 -050049<td width="100%"><dl><dt>Method resolution order:</dt>
50<dd><a href="oauth2client.file.html#Storage">Storage</a></dd>
51<dd><a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a></dd>
52<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
53</dl>
54<hr>
55Methods defined here:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -050056<dl><dt><a name="Storage-__init__"><strong>__init__</strong></a>(self, filename)</dt></dl>
57
58<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve&nbsp;Credential&nbsp;from&nbsp;file.<br>
59&nbsp;<br>
60Returns:<br>
Joe Gregorio3b79fa82011-02-17 11:47:17 -050061&nbsp;&nbsp;oauth2client.client.Credentials</tt></dd></dl>
Joe Gregorio6e537032011-02-09 23:04:26 -050062
63<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write&nbsp;a&nbsp;pickled&nbsp;Credentials&nbsp;to&nbsp;file.<br>
64&nbsp;<br>
65Args:<br>
66&nbsp;&nbsp;credentials:&nbsp;Credentials,&nbsp;the&nbsp;credentials&nbsp;to&nbsp;store.</tt></dd></dl>
67
68<hr>
Joe Gregorio3b79fa82011-02-17 11:47:17 -050069Data descriptors inherited from <a href="oauth2client.client.html#Storage">oauth2client.client.Storage</a>:<br>
Joe Gregorio6e537032011-02-09 23:04:26 -050070<dl><dt><strong>__dict__</strong></dt>
71<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
72</dl>
73<dl><dt><strong>__weakref__</strong></dt>
74<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
75</dl>
76</td></tr></table></td></tr></table><p>
77<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
78<tr bgcolor="#55aa55">
79<td colspan=3 valign=bottom>&nbsp;<br>
80<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
81
82<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
83<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
84<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
85<tr bgcolor="#7799ee">
86<td colspan=3 valign=bottom>&nbsp;<br>
87<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
88
89<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
90<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
91</body></html>