Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f7b648f5281e17dfee86fe8eb048d5ff0a19ca81 / . / docs / epy / apiclient.push-module.html
blob: eb40b6c362c85d49f1b27d2991530559a5577920 [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>apiclient.push</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="apiclient-module.html">Package&nbsp;apiclient</a> ::
38 Module&nbsp;push
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="apiclient.push-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module push</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.push-pysrc.html">source&nbsp;code</a></span></p>
56<pre class="literalblock">
57Push notifications support.
58
59This code is based on experimental APIs and is subject to change.
60
61</pre>
62
63<hr />
64<div class="fields"> <p><strong>Author:</strong>
65 afshar@google.com (Ali Afshar)
66 </p>
67</div><!-- ==================== CLASSES ==================== -->
68<a name="section-Classes"></a>
69<table class="summary" border="1" cellpadding="3"
70 cellspacing="0" width="100%" bgcolor="white">
71<tr bgcolor="#70b0f0" class="table-header">
72 <td colspan="2" class="table-header">
73 <table border="0" cellpadding="0" cellspacing="0" width="100%">
74 <tr valign="top">
75 <td align="left"><span class="table-header">Classes</span></td>
76 <td align="right" valign="top"
77 ><span class="options">[<a href="#section-Classes"
78 class="privatelink" onclick="toggle_private();"
79 >hide private</a>]</span></td>
80 </tr>
81 </table>
82 </td>
83</tr>
84<tr>
85 <td width="15%" align="right" valign="top" class="summary">
86 <span class="summary-type">&nbsp;</span>
87 </td><td class="summary">
88 <a href="apiclient.push.InvalidSubscriptionRequestError-class.html" class="summary-name">InvalidSubscriptionRequestError</a><br />
89 The request cannot be subscribed.
90 </td>
91 </tr>
92<tr>
93 <td width="15%" align="right" valign="top" class="summary">
94 <span class="summary-type">&nbsp;</span>
95 </td><td class="summary">
96 <a href="apiclient.push.Channel-class.html" class="summary-name">Channel</a><br />
97 Base class for channel types.
98 </td>
99 </tr>
100<tr>
101 <td width="15%" align="right" valign="top" class="summary">
102 <span class="summary-type">&nbsp;</span>
103 </td><td class="summary">
104 <a href="apiclient.push.WebhookChannel-class.html" class="summary-name">WebhookChannel</a><br />
105 Channel for registering web hook notifications.
106 </td>
107 </tr>
108<tr>
109 <td width="15%" align="right" valign="top" class="summary">
110 <span class="summary-type">&nbsp;</span>
111 </td><td class="summary">
112 <a href="apiclient.push.Headers-class.html" class="summary-name">Headers</a><br />
113 Headers for managing subscriptions.
114 </td>
115 </tr>
116<tr>
117 <td width="15%" align="right" valign="top" class="summary">
118 <span class="summary-type">&nbsp;</span>
119 </td><td class="summary">
120 <a href="apiclient.push.Subscription-class.html" class="summary-name">Subscription</a><br />
121 Information about a subscription.
122 </td>
123 </tr>
124</table>
125<!-- ==================== FUNCTIONS ==================== -->
126<a name="section-Functions"></a>
127<table class="summary" border="1" cellpadding="3"
128 cellspacing="0" width="100%" bgcolor="white">
129<tr bgcolor="#70b0f0" class="table-header">
130 <td colspan="2" class="table-header">
131 <table border="0" cellpadding="0" cellspacing="0" width="100%">
132 <tr valign="top">
133 <td align="left"><span class="table-header">Functions</span></td>
134 <td align="right" valign="top"
135 ><span class="options">[<a href="#section-Functions"
136 class="privatelink" onclick="toggle_private();"
137 >hide private</a>]</span></td>
138 </tr>
139 </table>
140 </td>
141</tr>
142<tr>
143 <td width="15%" align="right" valign="top" class="summary">
144 <span class="summary-type">&nbsp;</span>
145 </td><td class="summary">
146 <table width="100%" cellpadding="0" cellspacing="0" border="0">
147 <tr>
148 <td><span class="summary-sig"><a href="apiclient.push-module.html#new_token" class="summary-sig-name">new_token</a>()</span><br />
149 Gets a random token for use as a client_token in push notifications.</td>
150 <td align="right" valign="top">
151 <span class="codelink"><a href="apiclient.push-pysrc.html#new_token">source&nbsp;code</a></span>
152
153 </td>
154 </tr>
155 </table>
156
157 </td>
158 </tr>
159</table>
160<!-- ==================== VARIABLES ==================== -->
161<a name="section-Variables"></a>
162<table class="summary" border="1" cellpadding="3"
163 cellspacing="0" width="100%" bgcolor="white">
164<tr bgcolor="#70b0f0" class="table-header">
165 <td colspan="2" class="table-header">
166 <table border="0" cellpadding="0" cellspacing="0" width="100%">
167 <tr valign="top">
168 <td align="left"><span class="table-header">Variables</span></td>
169 <td align="right" valign="top"
170 ><span class="options">[<a href="#section-Variables"
171 class="privatelink" onclick="toggle_private();"
172 >hide private</a>]</span></td>
173 </tr>
174 </table>
175 </td>
176</tr>
177<tr>
178 <td width="15%" align="right" valign="top" class="summary">
179 <span class="summary-type">&nbsp;</span>
180 </td><td class="summary">
181 <a name="SUBSCRIBE"></a><span class="summary-name">SUBSCRIBE</span> = <code title="'X-GOOG-SUBSCRIBE'">'X-GOOG-SUBSCRIBE'</code>
182 </td>
183 </tr>
184<tr>
185 <td width="15%" align="right" valign="top" class="summary">
186 <span class="summary-type">&nbsp;</span>
187 </td><td class="summary">
188 <a name="SUBSCRIPTION_ID"></a><span class="summary-name">SUBSCRIPTION_ID</span> = <code title="'X-GOOG-SUBSCRIPTION-ID'">'X-GOOG-SUBSCRIPTION-ID'</code>
189 </td>
190 </tr>
191<tr>
192 <td width="15%" align="right" valign="top" class="summary">
193 <span class="summary-type">&nbsp;</span>
194 </td><td class="summary">
195 <a name="TOPIC_ID"></a><span class="summary-name">TOPIC_ID</span> = <code title="'X-GOOG-TOPIC-ID'">'X-GOOG-TOPIC-ID'</code>
196 </td>
197 </tr>
198<tr>
199 <td width="15%" align="right" valign="top" class="summary">
200 <span class="summary-type">&nbsp;</span>
201 </td><td class="summary">
202 <a name="TOPIC_URI"></a><span class="summary-name">TOPIC_URI</span> = <code title="'X-GOOG-TOPIC-URI'">'X-GOOG-TOPIC-URI'</code>
203 </td>
204 </tr>
205<tr>
206 <td width="15%" align="right" valign="top" class="summary">
207 <span class="summary-type">&nbsp;</span>
208 </td><td class="summary">
209 <a name="CLIENT_TOKEN"></a><span class="summary-name">CLIENT_TOKEN</span> = <code title="'X-GOOG-CLIENT-TOKEN'">'X-GOOG-CLIENT-TOKEN'</code>
210 </td>
211 </tr>
212<tr>
213 <td width="15%" align="right" valign="top" class="summary">
214 <span class="summary-type">&nbsp;</span>
215 </td><td class="summary">
216 <a name="EVENT_TYPE"></a><span class="summary-name">EVENT_TYPE</span> = <code title="'X-GOOG-EVENT-TYPE'">'X-GOOG-EVENT-TYPE'</code>
217 </td>
218 </tr>
219<tr>
220 <td width="15%" align="right" valign="top" class="summary">
221 <span class="summary-type">&nbsp;</span>
222 </td><td class="summary">
223 <a name="UNSUBSCRIBE"></a><span class="summary-name">UNSUBSCRIBE</span> = <code title="'X-GOOG-UNSUBSCRIBE'">'X-GOOG-UNSUBSCRIBE'</code>
224 </td>
225 </tr>
226</table>
227<!-- ==================== FUNCTION DETAILS ==================== -->
228<a name="section-FunctionDetails"></a>
229<table class="details" border="1" cellpadding="3"
230 cellspacing="0" width="100%" bgcolor="white">
231<tr bgcolor="#70b0f0" class="table-header">
232 <td colspan="2" class="table-header">
233 <table border="0" cellpadding="0" cellspacing="0" width="100%">
234 <tr valign="top">
235 <td align="left"><span class="table-header">Function Details</span></td>
236 <td align="right" valign="top"
237 ><span class="options">[<a href="#section-FunctionDetails"
238 class="privatelink" onclick="toggle_private();"
239 >hide private</a>]</span></td>
240 </tr>
241 </table>
242 </td>
243</tr>
244</table>
245<a name="new_token"></a>
246<div>
247<table class="details" border="1" cellpadding="3"
248 cellspacing="0" width="100%" bgcolor="white">
249<tr><td>
250 <table width="100%" cellpadding="0" cellspacing="0" border="0">
251 <tr valign="top"><td>
252 <h3 class="epydoc"><span class="sig"><span class="sig-name">new_token</span>()</span>
253 </h3>
254 </td><td align="right" valign="top"
255 ><span class="codelink"><a href="apiclient.push-pysrc.html#new_token">source&nbsp;code</a></span>&nbsp;
256 </td>
257 </tr></table>
258
259 <pre class="literalblock">
260Gets a random token for use as a client_token in push notifications.
261
262Returns:
263 str, a new random token.
264
265</pre>
266 <dl class="fields">
267 </dl>
268</td></tr></table>
269</div>
270<br />
271<!-- ==================== NAVIGATION BAR ==================== -->
272<table class="navbar" border="0" width="100%" cellpadding="0"
273 bgcolor="#a0c0ff" cellspacing="0">
274 <tr valign="middle">
275
276 <!-- Tree link -->
277 <th>&nbsp;&nbsp;&nbsp;<a
278 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
279
280 <!-- Index link -->
281 <th>&nbsp;&nbsp;&nbsp;<a
282 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
283
284 <!-- Help link -->
285 <th>&nbsp;&nbsp;&nbsp;<a
286 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
287
288 <th class="navbar" width="100%"></th>
289 </tr>
290</table>
291<table border="0" cellpadding="0" cellspacing="0" width="100%%">
292 <tr>
293 <td align="left" class="footer">
294 Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:31 2013
295 </td>
296 <td align="right" class="footer">
297 <a target="mainFrame" href="http://epydoc.sourceforge.net"
298 >http://epydoc.sourceforge.net</a>
299 </td>
300 </tr>
301</table>
302
303<script type="text/javascript">
304 <!--
305 // Private objects are initially displayed (because if
306 // javascript is turned off then we want them to be
307 // visible); but by default, we want to hide them. So hide
308 // them unless we have a cookie that says to show them.
309 checkCookie();
310 // -->
311</script>
312</body>
313</html>