blob: 67bd0ab133c9dc5e6ac0311e1a637b31fd9351b5 [file] [log] [blame]
Joe Gregorio52a5c532013-01-24 16:19:07 -05001<?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.WebhookChannel</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;WebhookChannel
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.WebhookChannel-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 WebhookChannel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.push-pysrc.html#WebhookChannel">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_webhookcha" name="class_hierarchy_for_webhookcha">
59<area shape="rect" id="node1" href="apiclient.push.Channel-class.html" title="Channel" alt="" coords="5,6,75,34"/>
60<area shape="rect" id="node2" href="apiclient.push.WebhookChannel-class.html" title="WebhookChannel" alt="" coords="99,6,224,34"/>
61</map>
62 <img src="class_hierarchy_for_webhookcha.gif" alt='' usemap="#class_hierarchy_for_webhookcha" ismap="ismap" class="graph-without-title" />
63</center>
64</center>
65<hr />
66<pre class="literalblock">
67Channel for registering web hook notifications.
68
69</pre>
70
71<!-- ==================== INSTANCE METHODS ==================== -->
72<a name="section-InstanceMethods"></a>
73<table class="summary" border="1" cellpadding="3"
74 cellspacing="0" width="100%" bgcolor="white">
75<tr bgcolor="#70b0f0" class="table-header">
76 <td colspan="2" class="table-header">
77 <table border="0" cellpadding="0" cellspacing="0" width="100%">
78 <tr valign="top">
79 <td align="left"><span class="table-header">Instance Methods</span></td>
80 <td align="right" valign="top"
81 ><span class="options">[<a href="#section-InstanceMethods"
82 class="privatelink" onclick="toggle_private();"
83 >hide private</a>]</span></td>
84 </tr>
85 </table>
86 </td>
87</tr>
88<tr>
89 <td width="15%" align="right" valign="top" class="summary">
90 <span class="summary-type">&nbsp;</span>
91 </td><td class="summary">
92 <table width="100%" cellpadding="0" cellspacing="0" border="0">
93 <tr>
94 <td><span class="summary-sig"><a href="apiclient.push.WebhookChannel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
95 <span class="summary-sig-arg">url</span>,
96 <span class="summary-sig-arg">app_engine</span>=<span class="summary-sig-default">False</span>)</span><br />
97 Create a new WebhookChannel</td>
98 <td align="right" valign="top">
99 <span class="codelink"><a href="apiclient.push-pysrc.html#WebhookChannel.__init__">source&nbsp;code</a></span>
100
101 </td>
102 </tr>
103 </table>
104
105 </td>
106 </tr>
107 <tr>
108 <td colspan="2" class="summary">
109 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="apiclient.push.Channel-class.html">Channel</a></code></b>:
110 <code><a href="apiclient.push.Channel-class.html#as_header_value">as_header_value</a></code>,
111 <code><a href="apiclient.push.Channel-class.html#write_header">write_header</a></code>
112 </p>
113 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
114 <code>__delattr__</code>,
115 <code>__format__</code>,
116 <code>__getattribute__</code>,
117 <code>__hash__</code>,
118 <code>__new__</code>,
119 <code>__reduce__</code>,
120 <code>__reduce_ex__</code>,
121 <code>__repr__</code>,
122 <code>__setattr__</code>,
123 <code>__sizeof__</code>,
124 <code>__str__</code>,
125 <code>__subclasshook__</code>
126 </p>
127 </td>
128 </tr>
129</table>
130<!-- ==================== PROPERTIES ==================== -->
131<a name="section-Properties"></a>
132<table class="summary" border="1" cellpadding="3"
133 cellspacing="0" width="100%" bgcolor="white">
134<tr bgcolor="#70b0f0" class="table-header">
135 <td colspan="2" class="table-header">
136 <table border="0" cellpadding="0" cellspacing="0" width="100%">
137 <tr valign="top">
138 <td align="left"><span class="table-header">Properties</span></td>
139 <td align="right" valign="top"
140 ><span class="options">[<a href="#section-Properties"
141 class="privatelink" onclick="toggle_private();"
142 >hide private</a>]</span></td>
143 </tr>
144 </table>
145 </td>
146</tr>
147 <tr>
148 <td colspan="2" class="summary">
149 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
150 <code>__class__</code>
151 </p>
152 </td>
153 </tr>
154</table>
155<!-- ==================== METHOD DETAILS ==================== -->
156<a name="section-MethodDetails"></a>
157<table class="details" border="1" cellpadding="3"
158 cellspacing="0" width="100%" bgcolor="white">
159<tr bgcolor="#70b0f0" class="table-header">
160 <td colspan="2" class="table-header">
161 <table border="0" cellpadding="0" cellspacing="0" width="100%">
162 <tr valign="top">
163 <td align="left"><span class="table-header">Method Details</span></td>
164 <td align="right" valign="top"
165 ><span class="options">[<a href="#section-MethodDetails"
166 class="privatelink" onclick="toggle_private();"
167 >hide private</a>]</span></td>
168 </tr>
169 </table>
170 </td>
171</tr>
172</table>
173<a name="__init__"></a>
174<div>
175<table class="details" border="1" cellpadding="3"
176 cellspacing="0" width="100%" bgcolor="white">
177<tr><td>
178 <table width="100%" cellpadding="0" cellspacing="0" border="0">
179 <tr valign="top"><td>
180 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
181 <span class="sig-arg">url</span>,
182 <span class="sig-arg">app_engine</span>=<span class="sig-default">False</span>)</span>
183 <br /><em class="fname">(Constructor)</em>
184 </h3>
185 </td><td align="right" valign="top"
186 ><span class="codelink"><a href="apiclient.push-pysrc.html#WebhookChannel.__init__">source&nbsp;code</a></span>&nbsp;
187 </td>
188 </tr></table>
189
190 <pre class="literalblock">
191Create a new WebhookChannel
192
193Args:
194 url: str, URL to post notifications to.
195 app_engine: bool, default=False, whether the destination for the
196 notifications is an App Engine application.
197
198</pre>
199 <dl class="fields">
200 <dt>Overrides:
201 object.__init__
202 </dt>
203 </dl>
204</td></tr></table>
205</div>
206<br />
207<!-- ==================== NAVIGATION BAR ==================== -->
208<table class="navbar" border="0" width="100%" cellpadding="0"
209 bgcolor="#a0c0ff" cellspacing="0">
210 <tr valign="middle">
211
212 <!-- Tree link -->
213 <th>&nbsp;&nbsp;&nbsp;<a
214 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
215
216 <!-- Index link -->
217 <th>&nbsp;&nbsp;&nbsp;<a
218 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
219
220 <!-- Help link -->
221 <th>&nbsp;&nbsp;&nbsp;<a
222 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
223
224 <th class="navbar" width="100%"></th>
225 </tr>
226</table>
227<table border="0" cellpadding="0" cellspacing="0" width="100%%">
228 <tr>
229 <td align="left" class="footer">
230 Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:38 2013
231 </td>
232 <td align="right" class="footer">
233 <a target="mainFrame" href="http://epydoc.sourceforge.net"
234 >http://epydoc.sourceforge.net</a>
235 </td>
236 </tr>
237</table>
238
239<script type="text/javascript">
240 <!--
241 // Private objects are initially displayed (because if
242 // javascript is turned off then we want them to be
243 // visible); but by default, we want to hide them. So hide
244 // them unless we have a cookie that says to show them.
245 checkCookie();
246 // -->
247</script>
248</body>
249</html>