Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3aaca548a7bea3c67d49c28f2b13b4cf9a21633b / . / docs / epy / apiclient.push.Subscription-class.html
blob: 6df582ae4e028e49de0b750621713415d467c9a5 [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.Subscription</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 <a href="apiclient.push-module.html">Module&nbsp;push</a> ::
39 Class&nbsp;Subscription
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="apiclient.push.Subscription-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 Subscription</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_subscripti" name="class_hierarchy_for_subscripti">
59<area shape="rect" id="node1" href="apiclient.push.Subscription-class.html" title="Subscription" alt="" coords="5,6,99,34"/>
60</map>
61 <img src="class_hierarchy_for_subscripti.gif" alt='' usemap="#class_hierarchy_for_subscripti" ismap="ismap" class="graph-without-title" />
62</center>
63</center>
64<hr />
65<pre class="literalblock">
66Information about a subscription.
67
68</pre>
69
70<!-- ==================== INSTANCE METHODS ==================== -->
71<a name="section-InstanceMethods"></a>
72<table class="summary" border="1" cellpadding="3"
73 cellspacing="0" width="100%" bgcolor="white">
74<tr bgcolor="#70b0f0" class="table-header">
75 <td colspan="2" class="table-header">
76 <table border="0" cellpadding="0" cellspacing="0" width="100%">
77 <tr valign="top">
78 <td align="left"><span class="table-header">Instance Methods</span></td>
79 <td align="right" valign="top"
80 ><span class="options">[<a href="#section-InstanceMethods"
81 class="privatelink" onclick="toggle_private();"
82 >hide private</a>]</span></td>
83 </tr>
84 </table>
85 </td>
86</tr>
87<tr>
88 <td width="15%" align="right" valign="top" class="summary">
89 <span class="summary-type">&nbsp;</span>
90 </td><td class="summary">
91 <table width="100%" cellpadding="0" cellspacing="0" border="0">
92 <tr>
93 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
94 Create a new Subscription.</td>
95 <td align="right" valign="top">
96 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.__init__">source&nbsp;code</a></span>
97
98 </td>
99 </tr>
100 </table>
101
102 </td>
103 </tr>
104<tr>
105 <td width="15%" align="right" valign="top" class="summary">
106 <span class="summary-type">&nbsp;</span>
107 </td><td class="summary">
108 <table width="100%" cellpadding="0" cellspacing="0" border="0">
109 <tr>
110 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#verify" class="summary-sig-name">verify</a>(<span class="summary-sig-arg">self</span>,
111 <span class="summary-sig-arg">headers</span>)</span><br />
112 Verifies that a webhook notification has the correct client_token.</td>
113 <td align="right" valign="top">
114 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.verify">source&nbsp;code</a></span>
115
116 </td>
117 </tr>
118 </table>
119
120 </td>
121 </tr>
122<tr>
123 <td width="15%" align="right" valign="top" class="summary">
124 <span class="summary-type">&nbsp;</span>
125 </td><td class="summary">
126 <table width="100%" cellpadding="0" cellspacing="0" border="0">
127 <tr>
128 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#subscribe" class="summary-sig-name">subscribe</a>(<span class="summary-sig-arg">self</span>)</span><br />
129 Subscribe header value.</td>
130 <td align="right" valign="top">
131 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.subscribe">source&nbsp;code</a></span>
132
133 </td>
134 </tr>
135 </table>
136
137 </td>
138 </tr>
139<tr>
140 <td width="15%" align="right" valign="top" class="summary">
141 <span class="summary-type">&nbsp;</span>
142 </td><td class="summary">
143 <table width="100%" cellpadding="0" cellspacing="0" border="0">
144 <tr>
145 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#subscription_id" class="summary-sig-name">subscription_id</a>(<span class="summary-sig-arg">self</span>)</span><br />
146 Subscription ID header value.</td>
147 <td align="right" valign="top">
148 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.subscription_id">source&nbsp;code</a></span>
149
150 </td>
151 </tr>
152 </table>
153
154 </td>
155 </tr>
156<tr>
157 <td width="15%" align="right" valign="top" class="summary">
158 <span class="summary-type">&nbsp;</span>
159 </td><td class="summary">
160 <table width="100%" cellpadding="0" cellspacing="0" border="0">
161 <tr>
162 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#topic_id" class="summary-sig-name">topic_id</a>(<span class="summary-sig-arg">self</span>)</span><br />
163 Topic ID header value.</td>
164 <td align="right" valign="top">
165 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.topic_id">source&nbsp;code</a></span>
166
167 </td>
168 </tr>
169 </table>
170
171 </td>
172 </tr>
173<tr>
174 <td width="15%" align="right" valign="top" class="summary">
175 <span class="summary-type">&nbsp;</span>
176 </td><td class="summary">
177 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <tr>
179 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#topic_uri" class="summary-sig-name">topic_uri</a>(<span class="summary-sig-arg">self</span>)</span><br />
180 Topic URI header value.</td>
181 <td align="right" valign="top">
182 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.topic_uri">source&nbsp;code</a></span>
183
184 </td>
185 </tr>
186 </table>
187
188 </td>
189 </tr>
190<tr>
191 <td width="15%" align="right" valign="top" class="summary">
192 <span class="summary-type">&nbsp;</span>
193 </td><td class="summary">
194 <table width="100%" cellpadding="0" cellspacing="0" border="0">
195 <tr>
196 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#client_token" class="summary-sig-name">client_token</a>(<span class="summary-sig-arg">self</span>)</span><br />
197 Client Token header value.</td>
198 <td align="right" valign="top">
199 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.client_token">source&nbsp;code</a></span>
200
201 </td>
202 </tr>
203 </table>
204
205 </td>
206 </tr>
207<tr>
208 <td width="15%" align="right" valign="top" class="summary">
209 <span class="summary-type">&nbsp;</span>
210 </td><td class="summary">
211 <table width="100%" cellpadding="0" cellspacing="0" border="0">
212 <tr>
213 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#event_type" class="summary-sig-name">event_type</a>(<span class="summary-sig-arg">self</span>)</span><br />
214 Event Type header value.</td>
215 <td align="right" valign="top">
216 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.event_type">source&nbsp;code</a></span>
217
218 </td>
219 </tr>
220 </table>
221
222 </td>
223 </tr>
224<tr>
225 <td width="15%" align="right" valign="top" class="summary">
226 <span class="summary-type">&nbsp;</span>
227 </td><td class="summary">
228 <table width="100%" cellpadding="0" cellspacing="0" border="0">
229 <tr>
230 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#unsubscribe" class="summary-sig-name">unsubscribe</a>(<span class="summary-sig-arg">self</span>)</span><br />
231 Unsuscribe header value.</td>
232 <td align="right" valign="top">
233 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.unsubscribe">source&nbsp;code</a></span>
234
235 </td>
236 </tr>
237 </table>
238
239 </td>
240 </tr>
241 <tr>
242 <td colspan="2" class="summary">
243 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
244 <code>__delattr__</code>,
245 <code>__format__</code>,
246 <code>__getattribute__</code>,
247 <code>__hash__</code>,
248 <code>__new__</code>,
249 <code>__reduce__</code>,
250 <code>__reduce_ex__</code>,
251 <code>__repr__</code>,
252 <code>__setattr__</code>,
253 <code>__sizeof__</code>,
254 <code>__str__</code>,
255 <code>__subclasshook__</code>
256 </p>
257 </td>
258 </tr>
259</table>
260<!-- ==================== CLASS METHODS ==================== -->
261<a name="section-ClassMethods"></a>
262<table class="summary" border="1" cellpadding="3"
263 cellspacing="0" width="100%" bgcolor="white">
264<tr bgcolor="#70b0f0" class="table-header">
265 <td colspan="2" class="table-header">
266 <table border="0" cellpadding="0" cellspacing="0" width="100%">
267 <tr valign="top">
268 <td align="left"><span class="table-header">Class Methods</span></td>
269 <td align="right" valign="top"
270 ><span class="options">[<a href="#section-ClassMethods"
271 class="privatelink" onclick="toggle_private();"
272 >hide private</a>]</span></td>
273 </tr>
274 </table>
275 </td>
276</tr>
277<tr>
278 <td width="15%" align="right" valign="top" class="summary">
279 <span class="summary-type">&nbsp;</span>
280 </td><td class="summary">
281 <table width="100%" cellpadding="0" cellspacing="0" border="0">
282 <tr>
283 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#for_request" class="summary-sig-name">for_request</a>(<span class="summary-sig-arg">cls</span>,
284 <span class="summary-sig-arg">request</span>,
285 <span class="summary-sig-arg">channel</span>,
286 <span class="summary-sig-arg">client_token</span>=<span class="summary-sig-default">None</span>)</span><br />
287 Creates a subscription and attaches it to a request.</td>
288 <td align="right" valign="top">
289 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.for_request">source&nbsp;code</a></span>
290
291 </td>
292 </tr>
293 </table>
294
295 </td>
296 </tr>
297<tr>
298 <td width="15%" align="right" valign="top" class="summary">
299 <span class="summary-type">&nbsp;</span>
300 </td><td class="summary">
301 <table width="100%" cellpadding="0" cellspacing="0" border="0">
302 <tr>
303 <td><span class="summary-sig"><a href="apiclient.push.Subscription-class.html#for_channel" class="summary-sig-name">for_channel</a>(<span class="summary-sig-arg">cls</span>,
304 <span class="summary-sig-arg">channel</span>,
305 <span class="summary-sig-arg">client_token</span>=<span class="summary-sig-default">None</span>)</span><br />
306 Alternate constructor to create a subscription from a channel.</td>
307 <td align="right" valign="top">
308 <span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.for_channel">source&nbsp;code</a></span>
309
310 </td>
311 </tr>
312 </table>
313
314 </td>
315 </tr>
316</table>
317<!-- ==================== PROPERTIES ==================== -->
318<a name="section-Properties"></a>
319<table class="summary" border="1" cellpadding="3"
320 cellspacing="0" width="100%" bgcolor="white">
321<tr bgcolor="#70b0f0" class="table-header">
322 <td colspan="2" class="table-header">
323 <table border="0" cellpadding="0" cellspacing="0" width="100%">
324 <tr valign="top">
325 <td align="left"><span class="table-header">Properties</span></td>
326 <td align="right" valign="top"
327 ><span class="options">[<a href="#section-Properties"
328 class="privatelink" onclick="toggle_private();"
329 >hide private</a>]</span></td>
330 </tr>
331 </table>
332 </td>
333</tr>
334 <tr>
335 <td colspan="2" class="summary">
336 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
337 <code>__class__</code>
338 </p>
339 </td>
340 </tr>
341</table>
342<!-- ==================== METHOD DETAILS ==================== -->
343<a name="section-MethodDetails"></a>
344<table class="details" border="1" cellpadding="3"
345 cellspacing="0" width="100%" bgcolor="white">
346<tr bgcolor="#70b0f0" class="table-header">
347 <td colspan="2" class="table-header">
348 <table border="0" cellpadding="0" cellspacing="0" width="100%">
349 <tr valign="top">
350 <td align="left"><span class="table-header">Method Details</span></td>
351 <td align="right" valign="top"
352 ><span class="options">[<a href="#section-MethodDetails"
353 class="privatelink" onclick="toggle_private();"
354 >hide private</a>]</span></td>
355 </tr>
356 </table>
357 </td>
358</tr>
359</table>
360<a name="__init__"></a>
361<div>
362<table class="details" border="1" cellpadding="3"
363 cellspacing="0" width="100%" bgcolor="white">
364<tr><td>
365 <table width="100%" cellpadding="0" cellspacing="0" border="0">
366 <tr valign="top"><td>
367 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
368 <br /><em class="fname">(Constructor)</em>
369 </h3>
370 </td><td align="right" valign="top"
371 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.__init__">source&nbsp;code</a></span>&nbsp;
372 </td>
373 </tr></table>
374
375 <pre class="literalblock">
376Create a new Subscription.
377
378</pre>
379 <dl class="fields">
380 <dt>Overrides:
381 object.__init__
382 </dt>
383 </dl>
384</td></tr></table>
385</div>
386<a name="for_request"></a>
387<div>
388<table class="details" border="1" cellpadding="3"
389 cellspacing="0" width="100%" bgcolor="white">
390<tr><td>
391 <table width="100%" cellpadding="0" cellspacing="0" border="0">
392 <tr valign="top"><td>
393 <h3 class="epydoc"><span class="sig"><span class="sig-name">for_request</span>(<span class="sig-arg">cls</span>,
394 <span class="sig-arg">request</span>,
395 <span class="sig-arg">channel</span>,
396 <span class="sig-arg">client_token</span>=<span class="sig-default">None</span>)</span>
397 <br /><em class="fname">Class Method</em>
398 </h3>
399 </td><td align="right" valign="top"
400 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.for_request">source&nbsp;code</a></span>&nbsp;
401 </td>
402 </tr></table>
403
404 <pre class="literalblock">
405Creates a subscription and attaches it to a request.
406
407Args:
408 request: An http.HttpRequest to modify for making a subscription.
409 channel: A apiclient.push.Channel describing the subscription to
410 create.
411 client_token: (optional) client token to verify the notification.
412
413Returns:
414 New subscription object.
415
416</pre>
417 <dl class="fields">
418 </dl>
419</td></tr></table>
420</div>
421<a name="for_channel"></a>
422<div>
423<table class="details" border="1" cellpadding="3"
424 cellspacing="0" width="100%" bgcolor="white">
425<tr><td>
426 <table width="100%" cellpadding="0" cellspacing="0" border="0">
427 <tr valign="top"><td>
428 <h3 class="epydoc"><span class="sig"><span class="sig-name">for_channel</span>(<span class="sig-arg">cls</span>,
429 <span class="sig-arg">channel</span>,
430 <span class="sig-arg">client_token</span>=<span class="sig-default">None</span>)</span>
431 <br /><em class="fname">Class Method</em>
432 </h3>
433 </td><td align="right" valign="top"
434 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.for_channel">source&nbsp;code</a></span>&nbsp;
435 </td>
436 </tr></table>
437
438 <pre class="literalblock">
439Alternate constructor to create a subscription from a channel.
440
441Args:
442 channel: A apiclient.push.Channel describing the subscription to
443 create.
444 client_token: (optional) client token to verify the notification.
445
446Returns:
447 New subscription object.
448
449</pre>
450 <dl class="fields">
451 </dl>
452</td></tr></table>
453</div>
454<a name="verify"></a>
455<div>
456<table class="details" border="1" cellpadding="3"
457 cellspacing="0" width="100%" bgcolor="white">
458<tr><td>
459 <table width="100%" cellpadding="0" cellspacing="0" border="0">
460 <tr valign="top"><td>
461 <h3 class="epydoc"><span class="sig"><span class="sig-name">verify</span>(<span class="sig-arg">self</span>,
462 <span class="sig-arg">headers</span>)</span>
463 </h3>
464 </td><td align="right" valign="top"
465 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.verify">source&nbsp;code</a></span>&nbsp;
466 </td>
467 </tr></table>
468
469 <pre class="literalblock">
470Verifies that a webhook notification has the correct client_token.
471
472Args:
473 headers: dict of request headers for a push notification.
474
475Returns:
476 Boolean value indicating whether the notification is verified.
477
478</pre>
479 <dl class="fields">
480 </dl>
481</td></tr></table>
482</div>
483<a name="subscribe"></a>
484<div>
485<table class="details" border="1" cellpadding="3"
486 cellspacing="0" width="100%" bgcolor="white">
487<tr><td>
488 <table width="100%" cellpadding="0" cellspacing="0" border="0">
489 <tr valign="top"><td>
490 <h3 class="epydoc"><span class="sig"><span class="sig-name">subscribe</span>(<span class="sig-arg">self</span>)</span>
491 </h3>
492 </td><td align="right" valign="top"
493 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.subscribe">source&nbsp;code</a></span>&nbsp;
494 </td>
495 </tr></table>
496
497 <pre class="literalblock">
498Subscribe header value.
499
500</pre>
501 <dl class="fields">
502 <dt>Decorators:</dt>
503 <dd><ul class="nomargin-top">
504 <li><code>@property</code></li>
505 </ul></dd>
506 </dl>
507</td></tr></table>
508</div>
509<a name="subscription_id"></a>
510<div>
511<table class="details" border="1" cellpadding="3"
512 cellspacing="0" width="100%" bgcolor="white">
513<tr><td>
514 <table width="100%" cellpadding="0" cellspacing="0" border="0">
515 <tr valign="top"><td>
516 <h3 class="epydoc"><span class="sig"><span class="sig-name">subscription_id</span>(<span class="sig-arg">self</span>)</span>
517 </h3>
518 </td><td align="right" valign="top"
519 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.subscription_id">source&nbsp;code</a></span>&nbsp;
520 </td>
521 </tr></table>
522
523 <pre class="literalblock">
524Subscription ID header value.
525
526</pre>
527 <dl class="fields">
528 <dt>Decorators:</dt>
529 <dd><ul class="nomargin-top">
530 <li><code>@property</code></li>
531 </ul></dd>
532 </dl>
533</td></tr></table>
534</div>
535<a name="topic_id"></a>
536<div>
537<table class="details" border="1" cellpadding="3"
538 cellspacing="0" width="100%" bgcolor="white">
539<tr><td>
540 <table width="100%" cellpadding="0" cellspacing="0" border="0">
541 <tr valign="top"><td>
542 <h3 class="epydoc"><span class="sig"><span class="sig-name">topic_id</span>(<span class="sig-arg">self</span>)</span>
543 </h3>
544 </td><td align="right" valign="top"
545 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.topic_id">source&nbsp;code</a></span>&nbsp;
546 </td>
547 </tr></table>
548
549 <pre class="literalblock">
550Topic ID header value.
551
552</pre>
553 <dl class="fields">
554 <dt>Decorators:</dt>
555 <dd><ul class="nomargin-top">
556 <li><code>@property</code></li>
557 </ul></dd>
558 </dl>
559</td></tr></table>
560</div>
561<a name="topic_uri"></a>
562<div>
563<table class="details" border="1" cellpadding="3"
564 cellspacing="0" width="100%" bgcolor="white">
565<tr><td>
566 <table width="100%" cellpadding="0" cellspacing="0" border="0">
567 <tr valign="top"><td>
568 <h3 class="epydoc"><span class="sig"><span class="sig-name">topic_uri</span>(<span class="sig-arg">self</span>)</span>
569 </h3>
570 </td><td align="right" valign="top"
571 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.topic_uri">source&nbsp;code</a></span>&nbsp;
572 </td>
573 </tr></table>
574
575 <pre class="literalblock">
576Topic URI header value.
577
578</pre>
579 <dl class="fields">
580 <dt>Decorators:</dt>
581 <dd><ul class="nomargin-top">
582 <li><code>@property</code></li>
583 </ul></dd>
584 </dl>
585</td></tr></table>
586</div>
587<a name="client_token"></a>
588<div>
589<table class="details" border="1" cellpadding="3"
590 cellspacing="0" width="100%" bgcolor="white">
591<tr><td>
592 <table width="100%" cellpadding="0" cellspacing="0" border="0">
593 <tr valign="top"><td>
594 <h3 class="epydoc"><span class="sig"><span class="sig-name">client_token</span>(<span class="sig-arg">self</span>)</span>
595 </h3>
596 </td><td align="right" valign="top"
597 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.client_token">source&nbsp;code</a></span>&nbsp;
598 </td>
599 </tr></table>
600
601 <pre class="literalblock">
602Client Token header value.
603
604</pre>
605 <dl class="fields">
606 <dt>Decorators:</dt>
607 <dd><ul class="nomargin-top">
608 <li><code>@property</code></li>
609 </ul></dd>
610 </dl>
611</td></tr></table>
612</div>
613<a name="event_type"></a>
614<div>
615<table class="details" border="1" cellpadding="3"
616 cellspacing="0" width="100%" bgcolor="white">
617<tr><td>
618 <table width="100%" cellpadding="0" cellspacing="0" border="0">
619 <tr valign="top"><td>
620 <h3 class="epydoc"><span class="sig"><span class="sig-name">event_type</span>(<span class="sig-arg">self</span>)</span>
621 </h3>
622 </td><td align="right" valign="top"
623 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.event_type">source&nbsp;code</a></span>&nbsp;
624 </td>
625 </tr></table>
626
627 <pre class="literalblock">
628Event Type header value.
629
630</pre>
631 <dl class="fields">
632 <dt>Decorators:</dt>
633 <dd><ul class="nomargin-top">
634 <li><code>@property</code></li>
635 </ul></dd>
636 </dl>
637</td></tr></table>
638</div>
639<a name="unsubscribe"></a>
640<div>
641<table class="details" border="1" cellpadding="3"
642 cellspacing="0" width="100%" bgcolor="white">
643<tr><td>
644 <table width="100%" cellpadding="0" cellspacing="0" border="0">
645 <tr valign="top"><td>
646 <h3 class="epydoc"><span class="sig"><span class="sig-name">unsubscribe</span>(<span class="sig-arg">self</span>)</span>
647 </h3>
648 </td><td align="right" valign="top"
649 ><span class="codelink"><a href="apiclient.push-pysrc.html#Subscription.unsubscribe">source&nbsp;code</a></span>&nbsp;
650 </td>
651 </tr></table>
652
653 <pre class="literalblock">
654Unsuscribe header value.
655
656</pre>
657 <dl class="fields">
658 <dt>Decorators:</dt>
659 <dd><ul class="nomargin-top">
660 <li><code>@property</code></li>
661 </ul></dd>
662 </dl>
663</td></tr></table>
664</div>
665<br />
666<!-- ==================== NAVIGATION BAR ==================== -->
667<table class="navbar" border="0" width="100%" cellpadding="0"
668 bgcolor="#a0c0ff" cellspacing="0">
669 <tr valign="middle">
670
671 <!-- Tree link -->
672 <th>&nbsp;&nbsp;&nbsp;<a
673 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
674
675 <!-- Index link -->
676 <th>&nbsp;&nbsp;&nbsp;<a
677 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
678
679 <!-- Help link -->
680 <th>&nbsp;&nbsp;&nbsp;<a
681 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
682
683 <th class="navbar" width="100%"></th>
684 </tr>
685</table>
686<table border="0" cellpadding="0" cellspacing="0" width="100%%">
687 <tr>
688 <td align="left" class="footer">
Joe Gregorio41be8e82013-03-07 10:31:47 -0500[diff] [blame]689 Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:24 2013
Joe Gregorio52a5c532013-01-24 16:19:07 -0500[diff] [blame]690 </td>
691 <td align="right" class="footer">
692 <a target="mainFrame" href="http://epydoc.sourceforge.net"
693 >http://epydoc.sourceforge.net</a>
694 </td>
695 </tr>
696</table>
697
698<script type="text/javascript">
699 <!--
700 // Private objects are initially displayed (because if
701 // javascript is turned off then we want them to be
702 // visible); but by default, we want to hide them. So hide
703 // them unless we have a cookie that says to show them.
704 checkCookie();
705 // -->
706</script>
707</body>
708</html>