Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 37802c34263ea5a0f9352df19ef3830a1f3be42f / . / docs / epy / oauth2client.appengine.CredentialsNDBModel-class.html
blob: 02c4e90aff9731e1fe3c23c2a35c966bca2bf67d [file] [log] [blame]
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.appengine.CredentialsNDBModel</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 <a href="oauth2client.appengine-module.html">Module&nbsp;appengine</a> ::
39 Class&nbsp;CredentialsNDBModel
40 </span>
41 </td>
42 <td>
43 <table cellpadding="0" cellspacing="0">
44 <!-- hide/show private -->
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47 <tr><td align="right"><span class="options"
48 >[<a href="frames.html" target="_top">frames</a
49 >]&nbsp;|&nbsp;<a href="oauth2client.appengine.CredentialsNDBModel-class.html"
50 target="_top">no&nbsp;frames</a>]</span></td></tr>
51 </table>
52 </td>
53 </tr>
54</table>
55<!-- ==================== CLASS DESCRIPTION ==================== -->
56<h1 class="epydoc">Class CredentialsNDBModel</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsNDBModel">source&nbsp;code</a></span></p>
57<center>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame^]58<center> <map id="uml_class_diagram_for_oauth2cl_3" name="uml_class_diagram_for_oauth2cl_3">
59<area shape="rect" id="node107" href="oauth2client.appengine.CredentialsNDBModel-class.html#credentials" title="oauth2client.appengine.CredentialsNDBModel.credentials" alt="" coords="17,95,149,113"/>
60<area shape="rect" id="node1" href="oauth2client.appengine.CredentialsNDBModel-class.html" title="NDB Model for storage of OAuth 2.0 Credentials" alt="" coords="5,70,160,127"/>
61<area shape="rect" id="node2" href="javascript:void(0);" title="??&#45;104" alt="" coords="51,6,115,50"/>
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]62</map>
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame^]63 <img src="uml_class_diagram_for_oauth2cl_3.gif" alt='' usemap="#uml_class_diagram_for_oauth2cl_3" ismap="ismap" class="graph-without-title" />
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]64</center>
65</center>
66<hr />
67<pre class="literalblock">
68NDB Model for storage of OAuth 2.0 Credentials
69
70Since this model uses the same kind as CredentialsModel and has a property
71which can serialize and deserialize Credentials correctly, it can be used
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]72interchangeably with a CredentialsModel to access, insert and delete the
73same entities. This simply provides an NDB model for interacting with the
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]74same data the DB model interacts with.
75
76Storage of the model is keyed by the user.user_id().
77
78</pre>
79
80<!-- ==================== CLASS METHODS ==================== -->
81<a name="section-ClassMethods"></a>
82<table class="summary" border="1" cellpadding="3"
83 cellspacing="0" width="100%" bgcolor="white">
84<tr bgcolor="#70b0f0" class="table-header">
85 <td colspan="2" class="table-header">
86 <table border="0" cellpadding="0" cellspacing="0" width="100%">
87 <tr valign="top">
88 <td align="left"><span class="table-header">Class Methods</span></td>
89 <td align="right" valign="top"
90 ><span class="options">[<a href="#section-ClassMethods"
91 class="privatelink" onclick="toggle_private();"
92 >hide private</a>]</span></td>
93 </tr>
94 </table>
95 </td>
96</tr>
97<tr class="private">
98 <td width="15%" align="right" valign="top" class="summary">
99 <span class="summary-type">&nbsp;</span>
100 </td><td class="summary">
101 <table width="100%" cellpadding="0" cellspacing="0" border="0">
102 <tr>
103 <td><span class="summary-sig"><a name="_get_kind"></a><span class="summary-sig-name">_get_kind</span>(<span class="summary-sig-arg">cls</span>)</span><br />
104 Return the kind name for this class.</td>
105 <td align="right" valign="top">
106 <span class="codelink"><a href="oauth2client.appengine-pysrc.html#CredentialsNDBModel._get_kind">source&nbsp;code</a></span>
107
108 </td>
109 </tr>
110 </table>
111
112 </td>
113 </tr>
114</table>
115<!-- ==================== CLASS VARIABLES ==================== -->
116<a name="section-ClassVariables"></a>
117<table class="summary" border="1" cellpadding="3"
118 cellspacing="0" width="100%" bgcolor="white">
119<tr bgcolor="#70b0f0" class="table-header">
120 <td colspan="2" class="table-header">
121 <table border="0" cellpadding="0" cellspacing="0" width="100%">
122 <tr valign="top">
123 <td align="left"><span class="table-header">Class Variables</span></td>
124 <td align="right" valign="top"
125 ><span class="options">[<a href="#section-ClassVariables"
126 class="privatelink" onclick="toggle_private();"
127 >hide private</a>]</span></td>
128 </tr>
129 </table>
130 </td>
131</tr>
132<tr>
133 <td width="15%" align="right" valign="top" class="summary">
134 <span class="summary-type">&nbsp;</span>
135 </td><td class="summary">
136 <a name="credentials"></a><span class="summary-name">credentials</span> = <code title="CredentialsNDBProperty()">CredentialsNDBProperty()</code>
137 </td>
138 </tr>
139</table>
140<!-- ==================== NAVIGATION BAR ==================== -->
141<table class="navbar" border="0" width="100%" cellpadding="0"
142 bgcolor="#a0c0ff" cellspacing="0">
143 <tr valign="middle">
144
145 <!-- Tree link -->
146 <th>&nbsp;&nbsp;&nbsp;<a
147 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
148
149 <!-- Index link -->
150 <th>&nbsp;&nbsp;&nbsp;<a
151 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
152
153 <!-- Help link -->
154 <th>&nbsp;&nbsp;&nbsp;<a
155 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
156
157 <th class="navbar" width="100%"></th>
158 </tr>
159</table>
160<table border="0" cellpadding="0" cellspacing="0" width="100%%">
161 <tr>
162 <td align="left" class="footer">
Joe Gregorio37802c32013-08-06 12:24:05 -0400[diff] [blame^]163 Generated by Epydoc 3.0.1 on Tue Aug 6 12:16:44 2013
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]164 </td>
165 <td align="right" class="footer">
166 <a target="mainFrame" href="http://epydoc.sourceforge.net"
167 >http://epydoc.sourceforge.net</a>
168 </td>
169 </tr>
170</table>
171
172<script type="text/javascript">
173 <!--
174 // Private objects are initially displayed (because if
175 // javascript is turned off then we want them to be
176 // visible); but by default, we want to hide them. So hide
177 // them unless we have a cookie that says to show them.
178 checkCookie();
179 // -->
180</script>
181</body>
182</html>