github_repo_scraped
/
repos
/googleapis-google-api-python-client-a9c62ce
/docs
/epy
/googleapiclient.channel.Channel-class.html
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
| <head> | |
| <title>googleapiclient.channel.Channel</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"> | |
| <!-- Home link --> | |
| <th> <a | |
| href="googleapiclient-module.html">Home</a> </th> | |
| <!-- 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="googleapiclient-module.html">Package googleapiclient</a> :: | |
| <a href="googleapiclient.channel-module.html">Module channel</a> :: | |
| Class Channel | |
| </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="googleapiclient.channel.Channel-class.html" | |
| target="_top">no frames</a>]</span></td></tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== CLASS DESCRIPTION ==================== --> | |
| <h1 class="epydoc">Class Channel</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel">source code</a></span></p> | |
| <pre class="base-tree"> | |
| object --+ | |
| | | |
| <strong class="uidshort">Channel</strong> | |
| </pre> | |
| <hr /> | |
| <pre class="literalblock"> | |
| A Channel for notifications. | |
| Usually not constructed directly, instead it is returned from helper | |
| functions like new_webhook_channel(). | |
| Attributes: | |
| type: str, The type of delivery mechanism used by this channel. For | |
| example, 'web_hook'. | |
| id: str, A UUID for the channel. | |
| token: str, An arbitrary string associated with the channel that | |
| is delivered to the target address with each event delivered | |
| over this channel. | |
| address: str, The address of the receiving entity where events are | |
| delivered. Specific to the channel type. | |
| expiration: int, The time, in milliseconds from the epoch, when this | |
| channel will expire. | |
| params: dict, A dictionary of string to string, with additional parameters | |
| controlling delivery channel behavior. | |
| resource_id: str, An opaque id that identifies the resource that is | |
| being watched. Stable across different API versions. | |
| resource_uri: str, The canonicalized ID of the watched resource. | |
| </pre> | |
| <!-- ==================== INSTANCE METHODS ==================== --> | |
| <a name="section-InstanceMethods"></a> | |
| <table class="summary" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Instance Methods</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-InstanceMethods" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.channel.Channel-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>, | |
| <span class="summary-sig-arg">**kwargs</span>)</span><br /> | |
| Create a new Channel.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel.__init__">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.channel.Channel-class.html#body" class="summary-sig-name">body</a>(<span class="summary-sig-arg">self</span>)</span><br /> | |
| Build a body from the Channel.</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel.body">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td width="15%" align="right" valign="top" class="summary"> | |
| <span class="summary-type"> </span> | |
| </td><td class="summary"> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr> | |
| <td><span class="summary-sig"><a href="googleapiclient.channel.Channel-class.html#update" class="summary-sig-name">update</a>(<span class="summary-sig-arg">self</span>, | |
| <span class="summary-sig-arg">resp</span>)</span><br /> | |
| Update a channel with information from the response of watch().</td> | |
| <td align="right" valign="top"> | |
| <span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel.update">source code</a></span> | |
| </td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td colspan="2" class="summary"> | |
| <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | |
| <code>__delattr__</code>, | |
| <code>__format__</code>, | |
| <code>__getattribute__</code>, | |
| <code>__hash__</code>, | |
| <code>__new__</code>, | |
| <code>__reduce__</code>, | |
| <code>__reduce_ex__</code>, | |
| <code>__repr__</code>, | |
| <code>__setattr__</code>, | |
| <code>__sizeof__</code>, | |
| <code>__str__</code>, | |
| <code>__subclasshook__</code> | |
| </p> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== PROPERTIES ==================== --> | |
| <a name="section-Properties"></a> | |
| <table class="summary" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Properties</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-Properties" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| <tr> | |
| <td colspan="2" class="summary"> | |
| <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: | |
| <code>__class__</code> | |
| </p> | |
| </td> | |
| </tr> | |
| </table> | |
| <!-- ==================== METHOD DETAILS ==================== --> | |
| <a name="section-MethodDetails"></a> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr bgcolor="#70b0f0" class="table-header"> | |
| <td colspan="2" class="table-header"> | |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> | |
| <tr valign="top"> | |
| <td align="left"><span class="table-header">Method Details</span></td> | |
| <td align="right" valign="top" | |
| ><span class="options">[<a href="#section-MethodDetails" | |
| class="privatelink" onclick="toggle_private();" | |
| >hide private</a>]</span></td> | |
| </tr> | |
| </table> | |
| </td> | |
| </tr> | |
| </table> | |
| <a name="__init__"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>, | |
| <span class="sig-arg">**kwargs</span>)</span> | |
| <br /><em class="fname">(Constructor)</em> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel.__init__">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Create a new Channel. | |
| In user code, this Channel constructor will not typically be called | |
| manually since there are functions for creating channels for each specific | |
| type with a more customized set of arguments to pass. | |
| Args: | |
| type: str, The type of delivery mechanism used by this channel. For | |
| example, 'web_hook'. | |
| id: str, A UUID for the channel. | |
| token: str, An arbitrary string associated with the channel that | |
| is delivered to the target address with each event delivered | |
| over this channel. | |
| address: str, The address of the receiving entity where events are | |
| delivered. Specific to the channel type. | |
| expiration: int, The time, in milliseconds from the epoch, when this | |
| channel will expire. | |
| params: dict, A dictionary of string to string, with additional parameters | |
| controlling delivery channel behavior. | |
| resource_id: str, An opaque id that identifies the resource that is | |
| being watched. Stable across different API versions. | |
| resource_uri: str, The canonicalized ID of the watched resource. | |
| </pre> | |
| <dl class="fields"> | |
| <dt>Decorators:</dt> | |
| <dd><ul class="nomargin-top"> | |
| <li><code>@util.positional(5)</code></li> | |
| </ul></dd> | |
| <dt>Overrides: | |
| object.__init__ | |
| </dt> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="body"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">body</span>(<span class="sig-arg">self</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel.body">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Build a body from the Channel. | |
| Constructs a dictionary that's appropriate for passing into watch() | |
| methods as the value of body argument. | |
| Returns: | |
| A dictionary representation of the channel. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <a name="update"></a> | |
| <div> | |
| <table class="details" border="1" cellpadding="3" | |
| cellspacing="0" width="100%" bgcolor="white"> | |
| <tr><td> | |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> | |
| <tr valign="top"><td> | |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">update</span>(<span class="sig-arg">self</span>, | |
| <span class="sig-arg">resp</span>)</span> | |
| </h3> | |
| </td><td align="right" valign="top" | |
| ><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Channel.update">source code</a></span> | |
| </td> | |
| </tr></table> | |
| <pre class="literalblock"> | |
| Update a channel with information from the response of watch(). | |
| When a request is sent to watch() a resource, the response returned | |
| from the watch() request is a dictionary with updated channel information, | |
| such as the resource_id, which is needed when stopping a subscription. | |
| Args: | |
| resp: dict, The response from a watch() method. | |
| </pre> | |
| <dl class="fields"> | |
| </dl> | |
| </td></tr></table> | |
| </div> | |
| <br /> | |
| <!-- ==================== NAVIGATION BAR ==================== --> | |
| <table class="navbar" border="0" width="100%" cellpadding="0" | |
| bgcolor="#a0c0ff" cellspacing="0"> | |
| <tr valign="middle"> | |
| <!-- Home link --> | |
| <th> <a | |
| href="googleapiclient-module.html">Home</a> </th> | |
| <!-- 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 Fri Oct 2 20:46:22 2020 | |
| </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"> | |
| </script> | |
| </body> | |
| </html> | |