| <?xml version="1.0" encoding="ascii"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <title>apiclient.push</title> |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
| <script type="text/javascript" src="epydoc.js"></script> |
| </head> |
| |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" |
| alink="#204080"> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></th> |
| </tr> |
| </table> |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr valign="top"> |
| <td width="100%"> |
| <span class="breadcrumbs"> |
| <a href="apiclient-module.html">Package apiclient</a> :: |
| Module push |
| </span> |
| </td> |
| <td> |
| <table cellpadding="0" cellspacing="0"> |
| <!-- hide/show private --> |
| <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
| onclick="toggle_private();">hide private</a>]</span></td></tr> |
| <tr><td align="right"><span class="options" |
| >[<a href="frames.html" target="_top">frames</a |
| >] | <a href="apiclient.push-pysrc.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <h1 class="epydoc">Source Code for <a href="apiclient.push-module.html">Module apiclient.push</a></h1> |
| <pre class="py-src"> |
| <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt> |
| <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"># you may not use this file except in compliance with the License.</tt> </tt> |
| <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"># You may obtain a copy of the License at</tt> </tt> |
| <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"># http://www.apache.org/licenses/LICENSE-2.0</tt> </tt> |
| <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> |
| <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># Unless required by applicable law or agreed to in writing, software</tt> </tt> |
| <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"># distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt> |
| <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt> |
| <a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"># See the License for the specific language governing permissions and</tt> </tt> |
| <a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># limitations under the License.</tt> </tt> |
| <a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"> </tt> |
| <a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">"""Push notifications support.</tt> </tt> |
| <a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-docstring">This code is based on experimental APIs and is subject to change.</tt> </tt> |
| <a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt> |
| <a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"> </tt> |
| <a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-name">__author__</tt> <tt class="py-op">=</tt> <tt class="py-string">'afshar@google.com (Ali Afshar)'</tt> </tt> |
| <a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"> </tt> |
| <a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">binascii</tt> </tt> |
| <a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">collections</tt> </tt> |
| <a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">os</tt> </tt> |
| <a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">urllib</tt> </tt> |
| <a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"> </tt> |
| <a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt id="link-0" class="py-name" targets="Variable apiclient.push.SUBSCRIBE=apiclient.push-module.html#SUBSCRIBE"><a title="apiclient.push.SUBSCRIBE" class="py-name" href="#" onclick="return doclink('link-0', 'SUBSCRIBE', 'link-0');">SUBSCRIBE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'X-GOOG-SUBSCRIBE'</tt> </tt> |
| <a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt id="link-1" class="py-name" targets="Variable apiclient.push.SUBSCRIPTION_ID=apiclient.push-module.html#SUBSCRIPTION_ID"><a title="apiclient.push.SUBSCRIPTION_ID" class="py-name" href="#" onclick="return doclink('link-1', 'SUBSCRIPTION_ID', 'link-1');">SUBSCRIPTION_ID</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'X-GOOG-SUBSCRIPTION-ID'</tt> </tt> |
| <a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt id="link-2" class="py-name" targets="Variable apiclient.push.TOPIC_ID=apiclient.push-module.html#TOPIC_ID"><a title="apiclient.push.TOPIC_ID" class="py-name" href="#" onclick="return doclink('link-2', 'TOPIC_ID', 'link-2');">TOPIC_ID</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'X-GOOG-TOPIC-ID'</tt> </tt> |
| <a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt id="link-3" class="py-name" targets="Variable apiclient.push.TOPIC_URI=apiclient.push-module.html#TOPIC_URI"><a title="apiclient.push.TOPIC_URI" class="py-name" href="#" onclick="return doclink('link-3', 'TOPIC_URI', 'link-3');">TOPIC_URI</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'X-GOOG-TOPIC-URI'</tt> </tt> |
| <a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt id="link-4" class="py-name" targets="Variable apiclient.push.CLIENT_TOKEN=apiclient.push-module.html#CLIENT_TOKEN"><a title="apiclient.push.CLIENT_TOKEN" class="py-name" href="#" onclick="return doclink('link-4', 'CLIENT_TOKEN', 'link-4');">CLIENT_TOKEN</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'X-GOOG-CLIENT-TOKEN'</tt> </tt> |
| <a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"><tt id="link-5" class="py-name" targets="Variable apiclient.push.EVENT_TYPE=apiclient.push-module.html#EVENT_TYPE"><a title="apiclient.push.EVENT_TYPE" class="py-name" href="#" onclick="return doclink('link-5', 'EVENT_TYPE', 'link-5');">EVENT_TYPE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'X-GOOG-EVENT-TYPE'</tt> </tt> |
| <a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt id="link-6" class="py-name" targets="Variable apiclient.push.UNSUBSCRIBE=apiclient.push-module.html#UNSUBSCRIBE"><a title="apiclient.push.UNSUBSCRIBE" class="py-name" href="#" onclick="return doclink('link-6', 'UNSUBSCRIBE', 'link-6');">UNSUBSCRIBE</a></tt> <tt class="py-op">=</tt> <tt class="py-string">'X-GOOG-UNSUBSCRIBE'</tt> </tt> |
| <a name="InvalidSubscriptionRequestError"></a><div id="InvalidSubscriptionRequestError-def"><a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"> </tt> |
| <a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> </tt> |
| <a name="L34"></a><tt class="py-lineno"> 34</tt> <a class="py-toggle" href="#" id="InvalidSubscriptionRequestError-toggle" onclick="return toggle('InvalidSubscriptionRequestError');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.push.InvalidSubscriptionRequestError-class.html">InvalidSubscriptionRequestError</a><tt class="py-op">(</tt><tt class="py-base-class">ValueError</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="InvalidSubscriptionRequestError-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="InvalidSubscriptionRequestError-expanded"><a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> <tt class="py-docstring">"""The request cannot be subscribed."""</tt> </tt> |
| </div><a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> </tt> |
| <a name="new_token"></a><div id="new_token-def"><a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> </tt> |
| <a name="L38"></a><tt class="py-lineno"> 38</tt> <a class="py-toggle" href="#" id="new_token-toggle" onclick="return toggle('new_token');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push-module.html#new_token">new_token</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="new_token-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="new_token-expanded"><a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-docstring">"""Gets a random token for use as a client_token in push notifications.</tt> </tt> |
| <a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> str, a new random token.</tt> </tt> |
| <a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">binascii</tt><tt class="py-op">.</tt><tt class="py-name">hexlify</tt><tt class="py-op">(</tt><tt class="py-name">os</tt><tt class="py-op">.</tt><tt class="py-name">urandom</tt><tt class="py-op">(</tt><tt class="py-number">32</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> </tt> |
| <a name="Channel"></a><div id="Channel-def"><a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> </tt> |
| <a name="L47"></a><tt class="py-lineno"> 47</tt> <a class="py-toggle" href="#" id="Channel-toggle" onclick="return toggle('Channel');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.push.Channel-class.html">Channel</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Channel-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Channel-expanded"><a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-docstring">"""Base class for channel types."""</tt> </tt> |
| <a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> </tt> |
| <a name="Channel.__init__"></a><div id="Channel.__init__-def"><a name="L50"></a><tt class="py-lineno"> 50</tt> <a class="py-toggle" href="#" id="Channel.__init__-toggle" onclick="return toggle('Channel.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Channel-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">channel_type</tt><tt class="py-op">,</tt> <tt class="py-param">channel_args</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Channel.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Channel.__init__-expanded"><a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new Channel.</tt> </tt> |
| <a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> You probably won't need to create this channel manually, since there are</tt> </tt> |
| <a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> subclassed Channel for each specific type with a more customized set of</tt> </tt> |
| <a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> arguments to pass. However, you may wish to just create it manually here.</tt> </tt> |
| <a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"> channel_type: str, the type of channel.</tt> </tt> |
| <a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> channel_args: dict, arguments to pass to the channel.</tt> </tt> |
| <a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">channel_type</tt> <tt class="py-op">=</tt> <tt class="py-name">channel_type</tt> </tt> |
| <a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">channel_args</tt> <tt class="py-op">=</tt> <tt class="py-name">channel_args</tt> </tt> |
| </div><a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"> </tt> |
| <a name="Channel.as_header_value"></a><div id="Channel.as_header_value-def"><a name="L64"></a><tt class="py-lineno"> 64</tt> <a class="py-toggle" href="#" id="Channel.as_header_value-toggle" onclick="return toggle('Channel.as_header_value');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Channel-class.html#as_header_value">as_header_value</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Channel.as_header_value-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Channel.as_header_value-expanded"><a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-docstring">"""Create the appropriate header for this channel.</tt> </tt> |
| <a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> str encoded channel description suitable for use as a header.</tt> </tt> |
| <a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-string">'%s?%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">channel_type</tt><tt class="py-op">,</tt> <tt class="py-name">urllib</tt><tt class="py-op">.</tt><tt class="py-name">urlencode</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">channel_args</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> </tt> |
| <a name="Channel.write_header"></a><div id="Channel.write_header-def"><a name="L72"></a><tt class="py-lineno"> 72</tt> <a class="py-toggle" href="#" id="Channel.write_header-toggle" onclick="return toggle('Channel.write_header');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Channel-class.html#write_header">write_header</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Channel.write_header-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Channel.write_header-expanded"><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-docstring">"""Write the appropriate subscribe header to a headers dict.</tt> </tt> |
| <a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict, headers to add subscribe header to.</tt> </tt> |
| <a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-7" class="py-name"><a title="apiclient.push.SUBSCRIBE" class="py-name" href="#" onclick="return doclink('link-7', 'SUBSCRIBE', 'link-0');">SUBSCRIBE</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method apiclient.push.Channel.as_header_value()=apiclient.push.Channel-class.html#as_header_value"><a title="apiclient.push.Channel.as_header_value" class="py-name" href="#" onclick="return doclink('link-8', 'as_header_value', 'link-8');">as_header_value</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| </div></div><a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> </tt> |
| <a name="WebhookChannel"></a><div id="WebhookChannel-def"><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> </tt> |
| <a name="L81"></a><tt class="py-lineno"> 81</tt> <a class="py-toggle" href="#" id="WebhookChannel-toggle" onclick="return toggle('WebhookChannel');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.push.WebhookChannel-class.html">WebhookChannel</a><tt class="py-op">(</tt><tt class="py-base-class">Channel</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="WebhookChannel-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="WebhookChannel-expanded"><a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-docstring">"""Channel for registering web hook notifications."""</tt> </tt> |
| <a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> </tt> |
| <a name="WebhookChannel.__init__"></a><div id="WebhookChannel.__init__-def"><a name="L84"></a><tt class="py-lineno"> 84</tt> <a class="py-toggle" href="#" id="WebhookChannel.__init__-toggle" onclick="return toggle('WebhookChannel.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.WebhookChannel-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">url</tt><tt class="py-op">,</tt> <tt class="py-param">app_engine</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="WebhookChannel.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="WebhookChannel.__init__-expanded"><a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new WebhookChannel</tt> </tt> |
| <a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> url: str, URL to post notifications to.</tt> </tt> |
| <a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> app_engine: bool, default=False, whether the destination for the</tt> </tt> |
| <a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> notifications is an App Engine application.</tt> </tt> |
| <a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> <tt class="py-name">super</tt><tt class="py-op">(</tt><tt id="link-9" class="py-name" targets="Class apiclient.push.WebhookChannel=apiclient.push.WebhookChannel-class.html"><a title="apiclient.push.WebhookChannel" class="py-name" href="#" onclick="return doclink('link-9', 'WebhookChannel', 'link-9');">WebhookChannel</a></tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Method apiclient.discovery.Resource.__init__()=apiclient.discovery.Resource-class.html#__init__,Method apiclient.discovery.ResourceMethodParameters.__init__()=apiclient.discovery.ResourceMethodParameters-class.html#__init__,Method apiclient.errors.BatchError.__init__()=apiclient.errors.BatchError-class.html#__init__,Method apiclient.errors.HttpError.__init__()=apiclient.errors.HttpError-class.html#__init__,Method apiclient.errors.UnexpectedBodyError.__init__()=apiclient.errors.UnexpectedBodyError-class.html#__init__,Method apiclient.errors.UnexpectedMethodError.__init__()=apiclient.errors.UnexpectedMethodError-class.html#__init__,Method apiclient.http.BatchHttpRequest.__init__()=apiclient.http.BatchHttpRequest-class.html#__init__,Method apiclient.http.HttpMock.__init__()=apiclient.http.HttpMock-class.html#__init__,Method apiclient.http.HttpMockSequence.__init__()=apiclient.http.HttpMockSequence-class.html#__init__,Method apiclient.http.HttpRequest.__init__()=apiclient.http.HttpRequest-class.html#__init__,Method apiclient.http.HttpRequestMock.__init__()=apiclient.http.HttpRequestMock-class.html#__init__,Method apiclient.http.MediaDownloadProgress.__init__()=apiclient.http.MediaDownloadProgress-class.html#__init__,Method apiclient.http.MediaFileUpload.__init__()=apiclient.http.MediaFileUpload-class.html#__init__,Method apiclient.http.MediaInMemoryUpload.__init__()=apiclient.http.MediaInMemoryUpload-class.html#__init__,Method apiclient.http.MediaIoBaseDownload.__init__()=apiclient.http.MediaIoBaseDownload-class.html#__init__,Method apiclient.http.MediaIoBaseUpload.__init__()=apiclient.http.MediaIoBaseUpload-class.html#__init__,Method apiclient.http.MediaUploadProgress.__init__()=apiclient.http.MediaUploadProgress-class.html#__init__,Method apiclient.http.RequestMockBuilder.__init__()=apiclient.http.RequestMockBuilder-class.html#__init__,Method apiclient.http._StreamSlice.__init__()=apiclient.http._StreamSlice-class.html#__init__,Method apiclient.model.JsonModel.__init__()=apiclient.model.JsonModel-class.html#__init__,Method apiclient.model.ProtocolBufferModel.__init__()=apiclient.model.ProtocolBufferModel-class.html#__init__,Method apiclient.push.Channel.__init__()=apiclient.push.Channel-class.html#__init__,Method apiclient.push.Headers.__init__()=apiclient.push.Headers-class.html#__init__,Method apiclient.push.Subscription.__init__()=apiclient.push.Subscription-class.html#__init__,Method apiclient.push.WebhookChannel.__init__()=apiclient.push.WebhookChannel-class.html#__init__,Method apiclient.schema.Schemas.__init__()=apiclient.schema.Schemas-class.html#__init__,Method apiclient.schema._SchemaToStruct.__init__()=apiclient.schema._SchemaToStruct-class.html#__init__,Method oauth2client.appengine.AppAssertionCredentials.__init__()=oauth2client.appengine.AppAssertionCredentials-class.html#__init__,Method oauth2client.appengine.OAuth2Decorator.__init__()=oauth2client.appengine.OAuth2Decorator-class.html#__init__,Method oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__()=oauth2client.appengine.OAuth2DecoratorFromClientSecrets-class.html#__init__,Method oauth2client.appengine.StorageByKeyName.__init__()=oauth2client.appengine.StorageByKeyName-class.html#__init__,Method oauth2client.client.AccessTokenCredentials.__init__()=oauth2client.client.AccessTokenCredentials-class.html#__init__,Method oauth2client.client.AssertionCredentials.__init__()=oauth2client.client.AssertionCredentials-class.html#__init__,Method oauth2client.client.MemoryCache.__init__()=oauth2client.client.MemoryCache-class.html#__init__,Method oauth2client.client.OAuth2Credentials.__init__()=oauth2client.client.OAuth2Credentials-class.html#__init__,Method oauth2client.client.OAuth2WebServerFlow.__init__()=oauth2client.client.OAuth2WebServerFlow-class.html#__init__,Method oauth2client.client.SignedJwtAssertionCredentials.__init__()=oauth2client.client.SignedJwtAssertionCredentials-class.html#__init__,Method oauth2client.django_orm.CredentialsField.__init__()=oauth2client.django_orm.CredentialsField-class.html#__init__,Method oauth2client.django_orm.FlowField.__init__()=oauth2client.django_orm.FlowField-class.html#__init__,Method oauth2client.django_orm.Storage.__init__()=oauth2client.django_orm.Storage-class.html#__init__,Method oauth2client.file.Storage.__init__()=oauth2client.file.Storage-class.html#__init__,Method oauth2client.gce.AppAssertionCredentials.__init__()=oauth2client.gce.AppAssertionCredentials-class.html#__init__,Method oauth2client.keyring_storage.Storage.__init__()=oauth2client.keyring_storage.Storage-class.html#__init__,Method oauth2client.locked_file.LockedFile.__init__()=oauth2client.locked_file.LockedFile-class.html#__init__,Method oauth2client.locked_file._Opener.__init__()=oauth2client.locked_file._Opener-class.html#__init__,Method oauth2client.multistore_file._MultiStore._Storage.__init__()=oauth2client.multistore_file._MultiStore._Storage-class.html#__init__,Method oauth2client.multistore_file._MultiStore.__init__()=oauth2client.multistore_file._MultiStore-class.html#__init__"><a title="apiclient.discovery.Resource.__init__ |
| apiclient.discovery.ResourceMethodParameters.__init__ |
| apiclient.errors.BatchError.__init__ |
| apiclient.errors.HttpError.__init__ |
| apiclient.errors.UnexpectedBodyError.__init__ |
| apiclient.errors.UnexpectedMethodError.__init__ |
| apiclient.http.BatchHttpRequest.__init__ |
| apiclient.http.HttpMock.__init__ |
| apiclient.http.HttpMockSequence.__init__ |
| apiclient.http.HttpRequest.__init__ |
| apiclient.http.HttpRequestMock.__init__ |
| apiclient.http.MediaDownloadProgress.__init__ |
| apiclient.http.MediaFileUpload.__init__ |
| apiclient.http.MediaInMemoryUpload.__init__ |
| apiclient.http.MediaIoBaseDownload.__init__ |
| apiclient.http.MediaIoBaseUpload.__init__ |
| apiclient.http.MediaUploadProgress.__init__ |
| apiclient.http.RequestMockBuilder.__init__ |
| apiclient.http._StreamSlice.__init__ |
| apiclient.model.JsonModel.__init__ |
| apiclient.model.ProtocolBufferModel.__init__ |
| apiclient.push.Channel.__init__ |
| apiclient.push.Headers.__init__ |
| apiclient.push.Subscription.__init__ |
| apiclient.push.WebhookChannel.__init__ |
| apiclient.schema.Schemas.__init__ |
| apiclient.schema._SchemaToStruct.__init__ |
| oauth2client.appengine.AppAssertionCredentials.__init__ |
| oauth2client.appengine.OAuth2Decorator.__init__ |
| oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ |
| oauth2client.appengine.StorageByKeyName.__init__ |
| oauth2client.client.AccessTokenCredentials.__init__ |
| oauth2client.client.AssertionCredentials.__init__ |
| oauth2client.client.MemoryCache.__init__ |
| oauth2client.client.OAuth2Credentials.__init__ |
| oauth2client.client.OAuth2WebServerFlow.__init__ |
| oauth2client.client.SignedJwtAssertionCredentials.__init__ |
| oauth2client.django_orm.CredentialsField.__init__ |
| oauth2client.django_orm.FlowField.__init__ |
| oauth2client.django_orm.Storage.__init__ |
| oauth2client.file.Storage.__init__ |
| oauth2client.gce.AppAssertionCredentials.__init__ |
| oauth2client.keyring_storage.Storage.__init__ |
| oauth2client.locked_file.LockedFile.__init__ |
| oauth2client.locked_file._Opener.__init__ |
| oauth2client.multistore_file._MultiStore._Storage.__init__ |
| oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-10', '__init__', 'link-10');">__init__</a></tt><tt class="py-op">(</tt> </tt> |
| <a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-name">channel_type</tt><tt class="py-op">=</tt><tt class="py-string">'web_hook'</tt><tt class="py-op">,</tt> </tt> |
| <a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-name">channel_args</tt><tt class="py-op">=</tt><tt class="py-op">{</tt> </tt> |
| <a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-string">'url'</tt><tt class="py-op">:</tt> <tt class="py-name">url</tt><tt class="py-op">,</tt> </tt> |
| <a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-string">'app_engine'</tt><tt class="py-op">:</tt> <tt class="py-name">app_engine</tt> <tt class="py-keyword">and</tt> <tt class="py-string">'true'</tt> <tt class="py-keyword">or</tt> <tt class="py-string">'false'</tt><tt class="py-op">,</tt> </tt> |
| <a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-op">}</tt> </tt> |
| <a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-op">)</tt> </tt> |
| </div></div><a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> </tt> |
| <a name="Headers"></a><div id="Headers-def"><a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> </tt> |
| <a name="L101"></a><tt class="py-lineno">101</tt> <a class="py-toggle" href="#" id="Headers-toggle" onclick="return toggle('Headers');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html">Headers</a><tt class="py-op">(</tt><tt class="py-base-class">collections</tt><tt class="py-op">.</tt><tt class="py-base-class">defaultdict</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Headers-expanded"><a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-docstring">"""Headers for managing subscriptions."""</tt> </tt> |
| <a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> </tt> |
| <a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> </tt> |
| <a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt id="link-11" class="py-name" targets="Variable apiclient.push.Headers.ALL_HEADERS=apiclient.push.Headers-class.html#ALL_HEADERS"><a title="apiclient.push.Headers.ALL_HEADERS" class="py-name" href="#" onclick="return doclink('link-11', 'ALL_HEADERS', 'link-11');">ALL_HEADERS</a></tt> <tt class="py-op">=</tt> <tt id="link-12" class="py-name" targets="Method oauth2client.client.MemoryCache.set()=oauth2client.client.MemoryCache-class.html#set"><a title="oauth2client.client.MemoryCache.set" class="py-name" href="#" onclick="return doclink('link-12', 'set', 'link-12');">set</a></tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt id="link-13" class="py-name"><a title="apiclient.push.SUBSCRIBE" class="py-name" href="#" onclick="return doclink('link-13', 'SUBSCRIBE', 'link-0');">SUBSCRIBE</a></tt><tt class="py-op">,</tt> <tt id="link-14" class="py-name"><a title="apiclient.push.SUBSCRIPTION_ID" class="py-name" href="#" onclick="return doclink('link-14', 'SUBSCRIPTION_ID', 'link-1');">SUBSCRIPTION_ID</a></tt><tt class="py-op">,</tt> <tt id="link-15" class="py-name"><a title="apiclient.push.TOPIC_ID" class="py-name" href="#" onclick="return doclink('link-15', 'TOPIC_ID', 'link-2');">TOPIC_ID</a></tt><tt class="py-op">,</tt> <tt id="link-16" class="py-name"><a title="apiclient.push.TOPIC_URI" class="py-name" href="#" onclick="return doclink('link-16', 'TOPIC_URI', 'link-3');">TOPIC_URI</a></tt><tt class="py-op">,</tt> </tt> |
| <a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> <tt id="link-17" class="py-name"><a title="apiclient.push.CLIENT_TOKEN" class="py-name" href="#" onclick="return doclink('link-17', 'CLIENT_TOKEN', 'link-4');">CLIENT_TOKEN</a></tt><tt class="py-op">,</tt> <tt id="link-18" class="py-name"><a title="apiclient.push.EVENT_TYPE" class="py-name" href="#" onclick="return doclink('link-18', 'EVENT_TYPE', 'link-5');">EVENT_TYPE</a></tt><tt class="py-op">,</tt> <tt id="link-19" class="py-name"><a title="apiclient.push.UNSUBSCRIBE" class="py-name" href="#" onclick="return doclink('link-19', 'UNSUBSCRIBE', 'link-6');">UNSUBSCRIBE</a></tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt> |
| <a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"> </tt> |
| <a name="Headers.__init__"></a><div id="Headers.__init__-def"><a name="L108"></a><tt class="py-lineno">108</tt> <a class="py-toggle" href="#" id="Headers.__init__-toggle" onclick="return toggle('Headers.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Headers.__init__-expanded"><a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new subscription configuration instance."""</tt> </tt> |
| <a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> <tt class="py-name">collections</tt><tt class="py-op">.</tt><tt class="py-name">defaultdict</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="apiclient.discovery.Resource.__init__ |
| apiclient.discovery.ResourceMethodParameters.__init__ |
| apiclient.errors.BatchError.__init__ |
| apiclient.errors.HttpError.__init__ |
| apiclient.errors.UnexpectedBodyError.__init__ |
| apiclient.errors.UnexpectedMethodError.__init__ |
| apiclient.http.BatchHttpRequest.__init__ |
| apiclient.http.HttpMock.__init__ |
| apiclient.http.HttpMockSequence.__init__ |
| apiclient.http.HttpRequest.__init__ |
| apiclient.http.HttpRequestMock.__init__ |
| apiclient.http.MediaDownloadProgress.__init__ |
| apiclient.http.MediaFileUpload.__init__ |
| apiclient.http.MediaInMemoryUpload.__init__ |
| apiclient.http.MediaIoBaseDownload.__init__ |
| apiclient.http.MediaIoBaseUpload.__init__ |
| apiclient.http.MediaUploadProgress.__init__ |
| apiclient.http.RequestMockBuilder.__init__ |
| apiclient.http._StreamSlice.__init__ |
| apiclient.model.JsonModel.__init__ |
| apiclient.model.ProtocolBufferModel.__init__ |
| apiclient.push.Channel.__init__ |
| apiclient.push.Headers.__init__ |
| apiclient.push.Subscription.__init__ |
| apiclient.push.WebhookChannel.__init__ |
| apiclient.schema.Schemas.__init__ |
| apiclient.schema._SchemaToStruct.__init__ |
| oauth2client.appengine.AppAssertionCredentials.__init__ |
| oauth2client.appengine.OAuth2Decorator.__init__ |
| oauth2client.appengine.OAuth2DecoratorFromClientSecrets.__init__ |
| oauth2client.appengine.StorageByKeyName.__init__ |
| oauth2client.client.AccessTokenCredentials.__init__ |
| oauth2client.client.AssertionCredentials.__init__ |
| oauth2client.client.MemoryCache.__init__ |
| oauth2client.client.OAuth2Credentials.__init__ |
| oauth2client.client.OAuth2WebServerFlow.__init__ |
| oauth2client.client.SignedJwtAssertionCredentials.__init__ |
| oauth2client.django_orm.CredentialsField.__init__ |
| oauth2client.django_orm.FlowField.__init__ |
| oauth2client.django_orm.Storage.__init__ |
| oauth2client.file.Storage.__init__ |
| oauth2client.gce.AppAssertionCredentials.__init__ |
| oauth2client.keyring_storage.Storage.__init__ |
| oauth2client.locked_file.LockedFile.__init__ |
| oauth2client.locked_file._Opener.__init__ |
| oauth2client.multistore_file._MultiStore._Storage.__init__ |
| oauth2client.multistore_file._MultiStore.__init__" class="py-name" href="#" onclick="return doclink('link-20', '__init__', 'link-10');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">str</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"> </tt> |
| <a name="Headers.__setitem__"></a><div id="Headers.__setitem__-def"><a name="L112"></a><tt class="py-lineno">112</tt> <a class="py-toggle" href="#" id="Headers.__setitem__-toggle" onclick="return toggle('Headers.__setitem__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html#__setitem__">__setitem__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">,</tt> <tt class="py-param">value</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers.__setitem__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Headers.__setitem__-expanded"><a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"> <tt class="py-docstring">"""Set a header value, ensuring the key is an allowed value.</tt> </tt> |
| <a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"><tt class="py-docstring"> key: str, the header key.</tt> </tt> |
| <a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"> value: str, the header value.</tt> </tt> |
| <a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| <a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> ValueError if key is not one of the accepted headers.</tt> </tt> |
| <a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-name">normal_key</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name" targets="Method apiclient.push.Headers._normalize_key()=apiclient.push.Headers-class.html#_normalize_key"><a title="apiclient.push.Headers._normalize_key" class="py-name" href="#" onclick="return doclink('link-21', '_normalize_key', 'link-21');">_normalize_key</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt> |
| <a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">normal_key</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="apiclient.push.Headers.ALL_HEADERS" class="py-name" href="#" onclick="return doclink('link-22', 'ALL_HEADERS', 'link-11');">ALL_HEADERS</a></tt><tt class="py-op">:</tt> </tt> |
| <a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Header name must be one of %s.'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="apiclient.push.Headers.ALL_HEADERS" class="py-name" href="#" onclick="return doclink('link-23', 'ALL_HEADERS', 'link-11');">ALL_HEADERS</a></tt><tt class="py-op">)</tt> </tt> |
| <a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| <a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">collections</tt><tt class="py-op">.</tt><tt class="py-name">defaultdict</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name" targets="Method apiclient.push.Headers.__setitem__()=apiclient.push.Headers-class.html#__setitem__"><a title="apiclient.push.Headers.__setitem__" class="py-name" href="#" onclick="return doclink('link-24', '__setitem__', 'link-24');">__setitem__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">normal_key</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> </tt> |
| <a name="Headers.__getitem__"></a><div id="Headers.__getitem__-def"><a name="L127"></a><tt class="py-lineno">127</tt> <a class="py-toggle" href="#" id="Headers.__getitem__-toggle" onclick="return toggle('Headers.__getitem__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html#__getitem__">__getitem__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers.__getitem__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Headers.__getitem__-expanded"><a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-docstring">"""Get a header value, normalizing the key case.</tt> </tt> |
| <a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"><tt class="py-docstring"> key: str, the header key.</tt> </tt> |
| <a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"><tt class="py-docstring"> String header value.</tt> </tt> |
| <a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"><tt class="py-docstring"> Raises:</tt> </tt> |
| <a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-docstring"> KeyError if the key is not one of the accepted headers.</tt> </tt> |
| <a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt class="py-name">normal_key</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="apiclient.push.Headers._normalize_key" class="py-name" href="#" onclick="return doclink('link-25', '_normalize_key', 'link-21');">_normalize_key</a></tt><tt class="py-op">(</tt><tt class="py-name">key</tt><tt class="py-op">)</tt> </tt> |
| <a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">normal_key</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="apiclient.push.Headers.ALL_HEADERS" class="py-name" href="#" onclick="return doclink('link-26', 'ALL_HEADERS', 'link-11');">ALL_HEADERS</a></tt><tt class="py-op">:</tt> </tt> |
| <a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt class="py-name">ValueError</tt><tt class="py-op">(</tt><tt class="py-string">'Header name must be one of %s.'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name"><a title="apiclient.push.Headers.ALL_HEADERS" class="py-name" href="#" onclick="return doclink('link-27', 'ALL_HEADERS', 'link-11');">ALL_HEADERS</a></tt><tt class="py-op">)</tt> </tt> |
| <a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt> |
| <a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">collections</tt><tt class="py-op">.</tt><tt class="py-name">defaultdict</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name" targets="Method apiclient.push.Headers.__getitem__()=apiclient.push.Headers-class.html#__getitem__"><a title="apiclient.push.Headers.__getitem__" class="py-name" href="#" onclick="return doclink('link-28', '__getitem__', 'link-28');">__getitem__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">normal_key</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> </tt> |
| <a name="Headers._normalize_key"></a><div id="Headers._normalize_key-def"><a name="L143"></a><tt class="py-lineno">143</tt> <a class="py-toggle" href="#" id="Headers._normalize_key-toggle" onclick="return toggle('Headers._normalize_key');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html#_normalize_key">_normalize_key</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">key</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers._normalize_key-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Headers._normalize_key-expanded"><a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-docstring">"""Normalize a header name for use as a key."""</tt> </tt> |
| <a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">key</tt><tt class="py-op">.</tt><tt class="py-name">upper</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> </tt> |
| <a name="Headers.items"></a><div id="Headers.items-def"><a name="L147"></a><tt class="py-lineno">147</tt> <a class="py-toggle" href="#" id="Headers.items-toggle" onclick="return toggle('Headers.items');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html#items">items</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers.items-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Headers.items-expanded"><a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt class="py-docstring">"""Generator for each header."""</tt> </tt> |
| <a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">header</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="apiclient.push.Headers.ALL_HEADERS" class="py-name" href="#" onclick="return doclink('link-29', 'ALL_HEADERS', 'link-11');">ALL_HEADERS</a></tt><tt class="py-op">:</tt> </tt> |
| <a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-name">value</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">header</tt><tt class="py-op">]</tt> </tt> |
| <a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">value</tt><tt class="py-op">:</tt> </tt> |
| <a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"> <tt class="py-keyword">yield</tt> <tt class="py-name">header</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> </tt> |
| </div><a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> </tt> |
| <a name="Headers.write"></a><div id="Headers.write-def"><a name="L154"></a><tt class="py-lineno">154</tt> <a class="py-toggle" href="#" id="Headers.write-toggle" onclick="return toggle('Headers.write');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html#write">write</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers.write-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Headers.write-expanded"><a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-docstring">"""Applies the subscription headers.</tt> </tt> |
| <a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict of headers to insert values into.</tt> </tt> |
| <a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">header</tt><tt class="py-op">,</tt> <tt class="py-name">value</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name" targets="Method apiclient.push.Headers.items()=apiclient.push.Headers-class.html#items"><a title="apiclient.push.Headers.items" class="py-name" href="#" onclick="return doclink('link-30', 'items', 'link-30');">items</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| <a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-name">header</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">value</tt> </tt> |
| </div><a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> </tt> |
| <a name="Headers.read"></a><div id="Headers.read-def"><a name="L163"></a><tt class="py-lineno">163</tt> <a class="py-toggle" href="#" id="Headers.read-toggle" onclick="return toggle('Headers.read');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Headers-class.html#read">read</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Headers.read-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Headers.read-expanded"><a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-docstring">"""Read from headers.</tt> </tt> |
| <a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict of headers to read from.</tt> </tt> |
| <a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">header</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="apiclient.push.Headers.ALL_HEADERS" class="py-name" href="#" onclick="return doclink('link-31', 'ALL_HEADERS', 'link-11');">ALL_HEADERS</a></tt><tt class="py-op">:</tt> </tt> |
| <a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">header</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">headers</tt><tt class="py-op">:</tt> </tt> |
| <a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">[</tt><tt class="py-name">header</tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt class="py-name">headers</tt><tt class="py-op">[</tt><tt class="py-name">header</tt><tt class="py-op">.</tt><tt class="py-name">lower</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt> </tt> |
| </div></div><a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"> </tt> |
| <a name="Subscription"></a><div id="Subscription-def"><a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> </tt> |
| <a name="L174"></a><tt class="py-lineno">174</tt> <a class="py-toggle" href="#" id="Subscription-toggle" onclick="return toggle('Subscription');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html">Subscription</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Subscription-expanded"><a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"> <tt class="py-docstring">"""Information about a subscription."""</tt> </tt> |
| <a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> </tt> |
| <a name="Subscription.__init__"></a><div id="Subscription.__init__-def"><a name="L177"></a><tt class="py-lineno">177</tt> <a class="py-toggle" href="#" id="Subscription.__init__-toggle" onclick="return toggle('Subscription.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.__init__-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.__init__-expanded"><a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> <tt class="py-docstring">"""Create a new Subscription."""</tt> </tt> |
| <a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt> <tt class="py-op">=</tt> <tt id="link-32" class="py-name" targets="Class apiclient.push.Headers=apiclient.push.Headers-class.html"><a title="apiclient.push.Headers" class="py-name" href="#" onclick="return doclink('link-32', 'Headers', 'link-32');">Headers</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> </tt> |
| <a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| <a name="Subscription.for_request"></a><div id="Subscription.for_request-def"><a name="L182"></a><tt class="py-lineno">182</tt> <a class="py-toggle" href="#" id="Subscription.for_request-toggle" onclick="return toggle('Subscription.for_request');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#for_request">for_request</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">request</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">client_token</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.for_request-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.for_request-expanded"><a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt class="py-docstring">"""Creates a subscription and attaches it to a request.</tt> </tt> |
| <a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"><tt class="py-docstring"> request: An http.HttpRequest to modify for making a subscription.</tt> </tt> |
| <a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"><tt class="py-docstring"> channel: A apiclient.push.Channel describing the subscription to</tt> </tt> |
| <a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"><tt class="py-docstring"> create.</tt> </tt> |
| <a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"><tt class="py-docstring"> client_token: (optional) client token to verify the notification.</tt> </tt> |
| <a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"><tt class="py-docstring"> New subscription object.</tt> </tt> |
| <a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-name">subscription</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name" targets="Class Method apiclient.push.Subscription.for_channel()=apiclient.push.Subscription-class.html#for_channel"><a title="apiclient.push.Subscription.for_channel" class="py-name" href="#" onclick="return doclink('link-33', 'for_channel', 'link-33');">for_channel</a></tt><tt class="py-op">(</tt><tt class="py-name">channel</tt><tt class="py-op">=</tt><tt class="py-name">channel</tt><tt class="py-op">,</tt> <tt id="link-34" class="py-name" targets="Method apiclient.push.Subscription.client_token()=apiclient.push.Subscription-class.html#client_token"><a title="apiclient.push.Subscription.client_token" class="py-name" href="#" onclick="return doclink('link-34', 'client_token', 'link-34');">client_token</a></tt><tt class="py-op">=</tt><tt id="link-35" class="py-name"><a title="apiclient.push.Subscription.client_token" class="py-name" href="#" onclick="return doclink('link-35', 'client_token', 'link-34');">client_token</a></tt><tt class="py-op">)</tt> </tt> |
| <a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> <tt class="py-name">subscription</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method apiclient.push.Headers.write()=apiclient.push.Headers-class.html#write"><a title="apiclient.push.Headers.write" class="py-name" href="#" onclick="return doclink('link-36', 'write', 'link-36');">write</a></tt><tt class="py-op">(</tt><tt id="link-37" class="py-name" targets="Method apiclient.http.HttpMock.request()=apiclient.http.HttpMock-class.html#request,Method apiclient.http.HttpMockSequence.request()=apiclient.http.HttpMockSequence-class.html#request,Method apiclient.model.BaseModel.request()=apiclient.model.BaseModel-class.html#request,Method apiclient.model.Model.request()=apiclient.model.Model-class.html#request"><a title="apiclient.http.HttpMock.request |
| apiclient.http.HttpMockSequence.request |
| apiclient.model.BaseModel.request |
| apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-37', 'request', 'link-37');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| <a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-38" class="py-name"><a title="apiclient.http.HttpMock.request |
| apiclient.http.HttpMockSequence.request |
| apiclient.model.BaseModel.request |
| apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-38', 'request', 'link-37');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">method</tt> <tt class="py-op">!=</tt> <tt class="py-string">'GET'</tt><tt class="py-op">:</tt> </tt> |
| <a name="L197"></a><tt class="py-lineno">197</tt> <tt class="py-line"> <tt class="py-keyword">raise</tt> <tt id="link-39" class="py-name" targets="Class apiclient.push.InvalidSubscriptionRequestError=apiclient.push.InvalidSubscriptionRequestError-class.html"><a title="apiclient.push.InvalidSubscriptionRequestError" class="py-name" href="#" onclick="return doclink('link-39', 'InvalidSubscriptionRequestError', 'link-39');">InvalidSubscriptionRequestError</a></tt><tt class="py-op">(</tt> </tt> |
| <a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> <tt class="py-string">'Can only subscribe to requests which are GET.'</tt><tt class="py-op">)</tt> </tt> |
| <a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> <tt id="link-40" class="py-name"><a title="apiclient.http.HttpMock.request |
| apiclient.http.HttpMockSequence.request |
| apiclient.model.BaseModel.request |
| apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-40', 'request', 'link-37');">request</a></tt><tt class="py-op">.</tt><tt class="py-name">method</tt> <tt class="py-op">=</tt> <tt class="py-string">'POST'</tt> </tt> |
| <a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> </tt> |
| <a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"> <tt class="py-keyword">def</tt> <tt class="py-def-name">_on_response</tt><tt class="py-op">(</tt><tt class="py-param">response</tt><tt class="py-op">,</tt> <tt class="py-param">subscription</tt><tt class="py-op">=</tt><tt class="py-name">subscription</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| <a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt class="py-docstring">"""Called with the response headers. Reads the subscription headers."""</tt> </tt> |
| <a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt class="py-name">subscription</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name" targets="Method apiclient.http._StreamSlice.read()=apiclient.http._StreamSlice-class.html#read,Method apiclient.push.Headers.read()=apiclient.push.Headers-class.html#read"><a title="apiclient.http._StreamSlice.read |
| apiclient.push.Headers.read" class="py-name" href="#" onclick="return doclink('link-41', 'read', 'link-41');">read</a></tt><tt class="py-op">(</tt><tt id="link-42" class="py-name" targets="Method apiclient.model.BaseModel.response()=apiclient.model.BaseModel-class.html#response,Method apiclient.model.Model.response()=apiclient.model.Model-class.html#response"><a title="apiclient.model.BaseModel.response |
| apiclient.model.Model.response" class="py-name" href="#" onclick="return doclink('link-42', 'response', 'link-42');">response</a></tt><tt class="py-op">)</tt> </tt> |
| </div><a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> </tt> |
| <a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt id="link-43" class="py-name"><a title="apiclient.http.HttpMock.request |
| apiclient.http.HttpMockSequence.request |
| apiclient.model.BaseModel.request |
| apiclient.model.Model.request" class="py-name" href="#" onclick="return doclink('link-43', 'request', 'link-37');">request</a></tt><tt class="py-op">.</tt><tt id="link-44" class="py-name" targets="Method apiclient.http.HttpRequest.add_response_callback()=apiclient.http.HttpRequest-class.html#add_response_callback"><a title="apiclient.http.HttpRequest.add_response_callback" class="py-name" href="#" onclick="return doclink('link-44', 'add_response_callback', 'link-44');">add_response_callback</a></tt><tt class="py-op">(</tt><tt class="py-name">_on_response</tt><tt class="py-op">)</tt> </tt> |
| <a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">subscription</tt> </tt> |
| </div><a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> </tt> |
| <a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">classmethod</tt> </tt> |
| <a name="Subscription.for_channel"></a><div id="Subscription.for_channel-def"><a name="L209"></a><tt class="py-lineno">209</tt> <a class="py-toggle" href="#" id="Subscription.for_channel-toggle" onclick="return toggle('Subscription.for_channel');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#for_channel">for_channel</a><tt class="py-op">(</tt><tt class="py-param">cls</tt><tt class="py-op">,</tt> <tt class="py-param">channel</tt><tt class="py-op">,</tt> <tt class="py-param">client_token</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.for_channel-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.for_channel-expanded"><a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> <tt class="py-docstring">"""Alternate constructor to create a subscription from a channel.</tt> </tt> |
| <a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"><tt class="py-docstring"> channel: A apiclient.push.Channel describing the subscription to</tt> </tt> |
| <a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"><tt class="py-docstring"> create.</tt> </tt> |
| <a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"><tt class="py-docstring"> client_token: (optional) client token to verify the notification.</tt> </tt> |
| <a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"><tt class="py-docstring"> New subscription object.</tt> </tt> |
| <a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-name">subscription</tt> <tt class="py-op">=</tt> <tt class="py-name">cls</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| <a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> <tt class="py-name">channel</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name" targets="Method apiclient.push.Channel.write_header()=apiclient.push.Channel-class.html#write_header"><a title="apiclient.push.Channel.write_header" class="py-name" href="#" onclick="return doclink('link-45', 'write_header', 'link-45');">write_header</a></tt><tt class="py-op">(</tt><tt class="py-name">subscription</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| <a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-46" class="py-name"><a title="apiclient.push.Subscription.client_token" class="py-name" href="#" onclick="return doclink('link-46', 'client_token', 'link-34');">client_token</a></tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt> |
| <a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt id="link-47" class="py-name"><a title="apiclient.push.Subscription.client_token" class="py-name" href="#" onclick="return doclink('link-47', 'client_token', 'link-34');">client_token</a></tt> <tt class="py-op">=</tt> <tt id="link-48" class="py-name" targets="Function apiclient.push.new_token()=apiclient.push-module.html#new_token"><a title="apiclient.push.new_token" class="py-name" href="#" onclick="return doclink('link-48', 'new_token', 'link-48');">new_token</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| <a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> <tt class="py-name">subscription</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-49" class="py-name"><a title="apiclient.push.SUBSCRIPTION_ID" class="py-name" href="#" onclick="return doclink('link-49', 'SUBSCRIPTION_ID', 'link-1');">SUBSCRIPTION_ID</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-50" class="py-name"><a title="apiclient.push.new_token" class="py-name" href="#" onclick="return doclink('link-50', 'new_token', 'link-48');">new_token</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| <a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> <tt class="py-name">subscription</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-51" class="py-name"><a title="apiclient.push.CLIENT_TOKEN" class="py-name" href="#" onclick="return doclink('link-51', 'CLIENT_TOKEN', 'link-4');">CLIENT_TOKEN</a></tt><tt class="py-op">]</tt> <tt class="py-op">=</tt> <tt id="link-52" class="py-name"><a title="apiclient.push.Subscription.client_token" class="py-name" href="#" onclick="return doclink('link-52', 'client_token', 'link-34');">client_token</a></tt> </tt> |
| <a name="L226"></a><tt class="py-lineno">226</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">subscription</tt> </tt> |
| </div><a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> </tt> |
| <a name="Subscription.verify"></a><div id="Subscription.verify-def"><a name="L228"></a><tt class="py-lineno">228</tt> <a class="py-toggle" href="#" id="Subscription.verify-toggle" onclick="return toggle('Subscription.verify');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#verify">verify</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">headers</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.verify-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.verify-expanded"><a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> <tt class="py-docstring">"""Verifies that a webhook notification has the correct client_token.</tt> </tt> |
| <a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L231"></a><tt class="py-lineno">231</tt> <tt class="py-line"><tt class="py-docstring"> Args:</tt> </tt> |
| <a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"><tt class="py-docstring"> headers: dict of request headers for a push notification.</tt> </tt> |
| <a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> |
| <a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> Returns:</tt> </tt> |
| <a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"><tt class="py-docstring"> Boolean value indicating whether the notification is verified.</tt> </tt> |
| <a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> |
| <a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"> <tt class="py-name">new_subscription</tt> <tt class="py-op">=</tt> <tt id="link-53" class="py-name" targets="Class apiclient.push.Subscription=apiclient.push.Subscription-class.html"><a title="apiclient.push.Subscription" class="py-name" href="#" onclick="return doclink('link-53', 'Subscription', 'link-53');">Subscription</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt> |
| <a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"> <tt class="py-name">new_subscription</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">.</tt><tt id="link-54" class="py-name"><a title="apiclient.http._StreamSlice.read |
| apiclient.push.Headers.read" class="py-name" href="#" onclick="return doclink('link-54', 'read', 'link-41');">read</a></tt><tt class="py-op">(</tt><tt class="py-name">headers</tt><tt class="py-op">)</tt> </tt> |
| <a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">new_subscription</tt><tt class="py-op">.</tt><tt id="link-55" class="py-name"><a title="apiclient.push.Subscription.client_token" class="py-name" href="#" onclick="return doclink('link-55', 'client_token', 'link-34');">client_token</a></tt> <tt class="py-op">==</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name"><a title="apiclient.push.Subscription.client_token" class="py-name" href="#" onclick="return doclink('link-56', 'client_token', 'link-34');">client_token</a></tt> </tt> |
| </div><a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"> </tt> |
| <a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| <a name="Subscription.subscribe"></a><div id="Subscription.subscribe-def"><a name="L242"></a><tt class="py-lineno">242</tt> <a class="py-toggle" href="#" id="Subscription.subscribe-toggle" onclick="return toggle('Subscription.subscribe');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#subscribe">subscribe</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.subscribe-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.subscribe-expanded"><a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-docstring">"""Subscribe header value."""</tt> </tt> |
| <a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-57" class="py-name"><a title="apiclient.push.SUBSCRIBE" class="py-name" href="#" onclick="return doclink('link-57', 'SUBSCRIBE', 'link-0');">SUBSCRIBE</a></tt><tt class="py-op">]</tt> </tt> |
| </div><a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> </tt> |
| <a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| <a name="Subscription.subscription_id"></a><div id="Subscription.subscription_id-def"><a name="L247"></a><tt class="py-lineno">247</tt> <a class="py-toggle" href="#" id="Subscription.subscription_id-toggle" onclick="return toggle('Subscription.subscription_id');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#subscription_id">subscription_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.subscription_id-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.subscription_id-expanded"><a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-docstring">"""Subscription ID header value."""</tt> </tt> |
| <a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-58" class="py-name"><a title="apiclient.push.SUBSCRIPTION_ID" class="py-name" href="#" onclick="return doclink('link-58', 'SUBSCRIPTION_ID', 'link-1');">SUBSCRIPTION_ID</a></tt><tt class="py-op">]</tt> </tt> |
| </div><a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> </tt> |
| <a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| <a name="Subscription.topic_id"></a><div id="Subscription.topic_id-def"><a name="L252"></a><tt class="py-lineno">252</tt> <a class="py-toggle" href="#" id="Subscription.topic_id-toggle" onclick="return toggle('Subscription.topic_id');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#topic_id">topic_id</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.topic_id-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.topic_id-expanded"><a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-docstring">"""Topic ID header value."""</tt> </tt> |
| <a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-59" class="py-name"><a title="apiclient.push.TOPIC_ID" class="py-name" href="#" onclick="return doclink('link-59', 'TOPIC_ID', 'link-2');">TOPIC_ID</a></tt><tt class="py-op">]</tt> </tt> |
| </div><a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> </tt> |
| <a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| <a name="Subscription.topic_uri"></a><div id="Subscription.topic_uri-def"><a name="L257"></a><tt class="py-lineno">257</tt> <a class="py-toggle" href="#" id="Subscription.topic_uri-toggle" onclick="return toggle('Subscription.topic_uri');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#topic_uri">topic_uri</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.topic_uri-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.topic_uri-expanded"><a name="L258"></a><tt class="py-lineno">258</tt> <tt class="py-line"> <tt class="py-docstring">"""Topic URI header value."""</tt> </tt> |
| <a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-60" class="py-name"><a title="apiclient.push.TOPIC_URI" class="py-name" href="#" onclick="return doclink('link-60', 'TOPIC_URI', 'link-3');">TOPIC_URI</a></tt><tt class="py-op">]</tt> </tt> |
| </div><a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"> </tt> |
| <a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| <a name="Subscription.client_token"></a><div id="Subscription.client_token-def"><a name="L262"></a><tt class="py-lineno">262</tt> <a class="py-toggle" href="#" id="Subscription.client_token-toggle" onclick="return toggle('Subscription.client_token');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#client_token">client_token</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.client_token-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.client_token-expanded"><a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"> <tt class="py-docstring">"""Client Token header value."""</tt> </tt> |
| <a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-61" class="py-name"><a title="apiclient.push.CLIENT_TOKEN" class="py-name" href="#" onclick="return doclink('link-61', 'CLIENT_TOKEN', 'link-4');">CLIENT_TOKEN</a></tt><tt class="py-op">]</tt> </tt> |
| </div><a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"> </tt> |
| <a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| <a name="Subscription.event_type"></a><div id="Subscription.event_type-def"><a name="L267"></a><tt class="py-lineno">267</tt> <a class="py-toggle" href="#" id="Subscription.event_type-toggle" onclick="return toggle('Subscription.event_type');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#event_type">event_type</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.event_type-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.event_type-expanded"><a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> <tt class="py-docstring">"""Event Type header value."""</tt> </tt> |
| <a name="L269"></a><tt class="py-lineno">269</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-62" class="py-name"><a title="apiclient.push.EVENT_TYPE" class="py-name" href="#" onclick="return doclink('link-62', 'EVENT_TYPE', 'link-5');">EVENT_TYPE</a></tt><tt class="py-op">]</tt> </tt> |
| </div><a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> </tt> |
| <a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"> <tt class="py-decorator">@</tt><tt class="py-decorator">property</tt> </tt> |
| <a name="Subscription.unsubscribe"></a><div id="Subscription.unsubscribe-def"><a name="L272"></a><tt class="py-lineno">272</tt> <a class="py-toggle" href="#" id="Subscription.unsubscribe-toggle" onclick="return toggle('Subscription.unsubscribe');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="apiclient.push.Subscription-class.html#unsubscribe">unsubscribe</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> |
| </div><div id="Subscription.unsubscribe-collapsed" style="display:none;" pad="+++" indent="++++++"></div><div id="Subscription.unsubscribe-expanded"><a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"> <tt class="py-docstring">"""Unsuscribe header value."""</tt> </tt> |
| <a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">headers</tt><tt class="py-op">[</tt><tt id="link-63" class="py-name"><a title="apiclient.push.UNSUBSCRIBE" class="py-name" href="#" onclick="return doclink('link-63', 'UNSUBSCRIBE', 'link-6');">UNSUBSCRIBE</a></tt><tt class="py-op">]</tt> </tt> |
| </div></div><a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"> </tt><script type="text/javascript"> |
| <!-- |
| expandto(location.href); |
| // --> |
| </script> |
| </pre> |
| <br /> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></th> |
| </tr> |
| </table> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| <tr> |
| <td align="left" class="footer"> |
| Generated by Epydoc 3.0.1 on Thu Mar 7 10:31:26 2013 |
| </td> |
| <td align="right" class="footer"> |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| >http://epydoc.sourceforge.net</a> |
| </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| <!-- |
| // Private objects are initially displayed (because if |
| // javascript is turned off then we want them to be |
| // visible); but by default, we want to hide them. So hide |
| // them unless we have a cookie that says to show them. |
| checkCookie(); |
| // --> |
| </script> |
| </body> |
| </html> |