Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f7b648f5281e17dfee86fe8eb048d5ff0a19ca81 / . / docs / epy / apiclient.push.Channel-class.html
blob: 5108eb694ea056bfa5e701fa1f08e26d088a5089 [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.Channel</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;Channel
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.Channel-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 Channel</h1><p class="nomargin-top"><span class="codelink"><a href="apiclient.push-pysrc.html#Channel">source&nbsp;code</a></span></p>
57<center>
58<center> <map id="class_hierarchy_for_channel" name="class_hierarchy_for_channel">
59<area shape="rect" id="node1" href="apiclient.push.Channel-class.html" title="Channel" alt="" coords="5,6,75,34"/>
60</map>
61 <img src="class_hierarchy_for_channel.gif" alt='' usemap="#class_hierarchy_for_channel" ismap="ismap" class="graph-without-title" />
62</center>
63</center>
64<hr />
65<pre class="literalblock">
66Base class for channel types.
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.Channel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
94 <span class="summary-sig-arg">channel_type</span>,
95 <span class="summary-sig-arg">channel_args</span>)</span><br />
96 Create a new Channel.</td>
97 <td align="right" valign="top">
98 <span class="codelink"><a href="apiclient.push-pysrc.html#Channel.__init__">source&nbsp;code</a></span>
99
100 </td>
101 </tr>
102 </table>
103
104 </td>
105 </tr>
106<tr>
107 <td width="15%" align="right" valign="top" class="summary">
108 <span class="summary-type">&nbsp;</span>
109 </td><td class="summary">
110 <table width="100%" cellpadding="0" cellspacing="0" border="0">
111 <tr>
112 <td><span class="summary-sig"><a href="apiclient.push.Channel-class.html#as_header_value" class="summary-sig-name">as_header_value</a>(<span class="summary-sig-arg">self</span>)</span><br />
113 Create the appropriate header for this channel.</td>
114 <td align="right" valign="top">
115 <span class="codelink"><a href="apiclient.push-pysrc.html#Channel.as_header_value">source&nbsp;code</a></span>
116
117 </td>
118 </tr>
119 </table>
120
121 </td>
122 </tr>
123<tr>
124 <td width="15%" align="right" valign="top" class="summary">
125 <span class="summary-type">&nbsp;</span>
126 </td><td class="summary">
127 <table width="100%" cellpadding="0" cellspacing="0" border="0">
128 <tr>
129 <td><span class="summary-sig"><a href="apiclient.push.Channel-class.html#write_header" class="summary-sig-name">write_header</a>(<span class="summary-sig-arg">self</span>,
130 <span class="summary-sig-arg">headers</span>)</span><br />
131 Write the appropriate subscribe header to a headers dict.</td>
132 <td align="right" valign="top">
133 <span class="codelink"><a href="apiclient.push-pysrc.html#Channel.write_header">source&nbsp;code</a></span>
134
135 </td>
136 </tr>
137 </table>
138
139 </td>
140 </tr>
141 <tr>
142 <td colspan="2" class="summary">
143 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
144 <code>__delattr__</code>,
145 <code>__format__</code>,
146 <code>__getattribute__</code>,
147 <code>__hash__</code>,
148 <code>__new__</code>,
149 <code>__reduce__</code>,
150 <code>__reduce_ex__</code>,
151 <code>__repr__</code>,
152 <code>__setattr__</code>,
153 <code>__sizeof__</code>,
154 <code>__str__</code>,
155 <code>__subclasshook__</code>
156 </p>
157 </td>
158 </tr>
159</table>
160<!-- ==================== PROPERTIES ==================== -->
161<a name="section-Properties"></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">Properties</span></td>
169 <td align="right" valign="top"
170 ><span class="options">[<a href="#section-Properties"
171 class="privatelink" onclick="toggle_private();"
172 >hide private</a>]</span></td>
173 </tr>
174 </table>
175 </td>
176</tr>
177 <tr>
178 <td colspan="2" class="summary">
179 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
180 <code>__class__</code>
181 </p>
182 </td>
183 </tr>
184</table>
185<!-- ==================== METHOD DETAILS ==================== -->
186<a name="section-MethodDetails"></a>
187<table class="details" border="1" cellpadding="3"
188 cellspacing="0" width="100%" bgcolor="white">
189<tr bgcolor="#70b0f0" class="table-header">
190 <td colspan="2" class="table-header">
191 <table border="0" cellpadding="0" cellspacing="0" width="100%">
192 <tr valign="top">
193 <td align="left"><span class="table-header">Method Details</span></td>
194 <td align="right" valign="top"
195 ><span class="options">[<a href="#section-MethodDetails"
196 class="privatelink" onclick="toggle_private();"
197 >hide private</a>]</span></td>
198 </tr>
199 </table>
200 </td>
201</tr>
202</table>
203<a name="__init__"></a>
204<div>
205<table class="details" border="1" cellpadding="3"
206 cellspacing="0" width="100%" bgcolor="white">
207<tr><td>
208 <table width="100%" cellpadding="0" cellspacing="0" border="0">
209 <tr valign="top"><td>
210 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
211 <span class="sig-arg">channel_type</span>,
212 <span class="sig-arg">channel_args</span>)</span>
213 <br /><em class="fname">(Constructor)</em>
214 </h3>
215 </td><td align="right" valign="top"
216 ><span class="codelink"><a href="apiclient.push-pysrc.html#Channel.__init__">source&nbsp;code</a></span>&nbsp;
217 </td>
218 </tr></table>
219
220 <pre class="literalblock">
221Create a new Channel.
222
223You probably won't need to create this channel manually, since there are
224subclassed Channel for each specific type with a more customized set of
225arguments to pass. However, you may wish to just create it manually here.
226
227Args:
228 channel_type: str, the type of channel.
229 channel_args: dict, arguments to pass to the channel.
230
231</pre>
232 <dl class="fields">
233 <dt>Overrides:
234 object.__init__
235 </dt>
236 </dl>
237</td></tr></table>
238</div>
239<a name="as_header_value"></a>
240<div>
241<table class="details" border="1" cellpadding="3"
242 cellspacing="0" width="100%" bgcolor="white">
243<tr><td>
244 <table width="100%" cellpadding="0" cellspacing="0" border="0">
245 <tr valign="top"><td>
246 <h3 class="epydoc"><span class="sig"><span class="sig-name">as_header_value</span>(<span class="sig-arg">self</span>)</span>
247 </h3>
248 </td><td align="right" valign="top"
249 ><span class="codelink"><a href="apiclient.push-pysrc.html#Channel.as_header_value">source&nbsp;code</a></span>&nbsp;
250 </td>
251 </tr></table>
252
253 <pre class="literalblock">
254Create the appropriate header for this channel.
255
256Returns:
257 str encoded channel description suitable for use as a header.
258
259</pre>
260 <dl class="fields">
261 </dl>
262</td></tr></table>
263</div>
264<a name="write_header"></a>
265<div>
266<table class="details" border="1" cellpadding="3"
267 cellspacing="0" width="100%" bgcolor="white">
268<tr><td>
269 <table width="100%" cellpadding="0" cellspacing="0" border="0">
270 <tr valign="top"><td>
271 <h3 class="epydoc"><span class="sig"><span class="sig-name">write_header</span>(<span class="sig-arg">self</span>,
272 <span class="sig-arg">headers</span>)</span>
273 </h3>
274 </td><td align="right" valign="top"
275 ><span class="codelink"><a href="apiclient.push-pysrc.html#Channel.write_header">source&nbsp;code</a></span>&nbsp;
276 </td>
277 </tr></table>
278
279 <pre class="literalblock">
280Write the appropriate subscribe header to a headers dict.
281
282Args:
283 headers: dict, headers to add subscribe header to.
284
285</pre>
286 <dl class="fields">
287 </dl>
288</td></tr></table>
289</div>
290<br />
291<!-- ==================== NAVIGATION BAR ==================== -->
292<table class="navbar" border="0" width="100%" cellpadding="0"
293 bgcolor="#a0c0ff" cellspacing="0">
294 <tr valign="middle">
295
296 <!-- Tree link -->
297 <th>&nbsp;&nbsp;&nbsp;<a
298 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
299
300 <!-- Index link -->
301 <th>&nbsp;&nbsp;&nbsp;<a
302 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
303
304 <!-- Help link -->
305 <th>&nbsp;&nbsp;&nbsp;<a
306 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
307
308 <th class="navbar" width="100%"></th>
309 </tr>
310</table>
311<table border="0" cellpadding="0" cellspacing="0" width="100%%">
312 <tr>
313 <td align="left" class="footer">
314 Generated by Epydoc 3.0.1 on Thu Jan 24 16:14:37 2013
315 </td>
316 <td align="right" class="footer">
317 <a target="mainFrame" href="http://epydoc.sourceforge.net"
318 >http://epydoc.sourceforge.net</a>
319 </td>
320 </tr>
321</table>
322
323<script type="text/javascript">
324 <!--
325 // Private objects are initially displayed (because if
326 // javascript is turned off then we want them to be
327 // visible); but by default, we want to hide them. So hide
328 // them unless we have a cookie that says to show them.
329 checkCookie();
330 // -->
331</script>
332</body>
333</html>