Home | History | Annotate | Download | only in epy
      1 <?xml version="1.0" encoding="ascii"?>
      2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
      3           "DTD/xhtml1-transitional.dtd">
      4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
      5 <head>
      6   <title>googleapiclient.channel.Notification</title>
      7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
      8   <script type="text/javascript" src="epydoc.js"></script>
      9 </head>
     10 
     11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
     12       alink="#204080">
     13 <!-- ==================== NAVIGATION BAR ==================== -->
     14 <table class="navbar" border="0" width="100%" cellpadding="0"
     15        bgcolor="#a0c0ff" cellspacing="0">
     16   <tr valign="middle">
     17   <!-- Home link -->
     18       <th>&nbsp;&nbsp;&nbsp;<a
     19         href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
     20 
     21   <!-- Tree link -->
     22       <th>&nbsp;&nbsp;&nbsp;<a
     23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
     24 
     25   <!-- Index link -->
     26       <th>&nbsp;&nbsp;&nbsp;<a
     27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
     28 
     29   <!-- Help link -->
     30       <th>&nbsp;&nbsp;&nbsp;<a
     31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
     32 
     33       <th class="navbar" width="100%"></th>
     34   </tr>
     35 </table>
     36 <table width="100%" cellpadding="0" cellspacing="0">
     37   <tr valign="top">
     38     <td width="100%">
     39       <span class="breadcrumbs">
     40         <a href="googleapiclient-module.html">Package&nbsp;googleapiclient</a> ::
     41         <a href="googleapiclient.channel-module.html">Module&nbsp;channel</a> ::
     42         Class&nbsp;Notification
     43       </span>
     44     </td>
     45     <td>
     46       <table cellpadding="0" cellspacing="0">
     47         <!-- hide/show private -->
     48         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
     49     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
     50         <tr><td align="right"><span class="options"
     51             >[<a href="frames.html" target="_top">frames</a
     52             >]&nbsp;|&nbsp;<a href="googleapiclient.channel.Notification-class.html"
     53             target="_top">no&nbsp;frames</a>]</span></td></tr>
     54       </table>
     55     </td>
     56   </tr>
     57 </table>
     58 <!-- ==================== CLASS DESCRIPTION ==================== -->
     59 <h1 class="epydoc">Class Notification</h1><p class="nomargin-top"><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Notification">source&nbsp;code</a></span></p>
     60 <center>
     61 
     62 </center>
     63 <hr />
     64 <pre class="literalblock">
     65 A Notification from a Channel.
     66 
     67 Notifications are not usually constructed directly, but are returned
     68 from functions like notification_from_headers().
     69 
     70 Attributes:
     71   message_number: int, The unique id number of this notification.
     72   state: str, The state of the resource being monitored.
     73   uri: str, The address of the resource being monitored.
     74   resource_id: str, The unique identifier of the version of the resource at
     75     this event.
     76 
     77 </pre>
     78 
     79 <!-- ==================== INSTANCE METHODS ==================== -->
     80 <a name="section-InstanceMethods"></a>
     81 <table class="summary" border="1" cellpadding="3"
     82        cellspacing="0" width="100%" bgcolor="white">
     83 <tr bgcolor="#70b0f0" class="table-header">
     84   <td colspan="2" class="table-header">
     85     <table border="0" cellpadding="0" cellspacing="0" width="100%">
     86       <tr valign="top">
     87         <td align="left"><span class="table-header">Instance Methods</span></td>
     88         <td align="right" valign="top"
     89          ><span class="options">[<a href="#section-InstanceMethods"
     90          class="privatelink" onclick="toggle_private();"
     91          >hide private</a>]</span></td>
     92       </tr>
     93     </table>
     94   </td>
     95 </tr>
     96 <tr>
     97     <td width="15%" align="right" valign="top" class="summary">
     98       <span class="summary-type">&nbsp;</span>
     99     </td><td class="summary">
    100       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    101         <tr>
    102           <td><span class="summary-sig"><a href="googleapiclient.channel.Notification-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    103         <span class="summary-sig-arg">message_number</span>,
    104         <span class="summary-sig-arg">state</span>,
    105         <span class="summary-sig-arg">resource_uri</span>,
    106         <span class="summary-sig-arg">resource_id</span>)</span><br />
    107       Notification constructor.</td>
    108           <td align="right" valign="top">
    109             <span class="codelink"><a href="googleapiclient.channel-pysrc.html#Notification.__init__">source&nbsp;code</a></span>
    110             
    111           </td>
    112         </tr>
    113       </table>
    114       
    115     </td>
    116   </tr>
    117   <tr>
    118     <td colspan="2" class="summary">
    119     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    120       <code>__delattr__</code>,
    121       <code>__format__</code>,
    122       <code>__getattribute__</code>,
    123       <code>__hash__</code>,
    124       <code>__new__</code>,
    125       <code>__reduce__</code>,
    126       <code>__reduce_ex__</code>,
    127       <code>__repr__</code>,
    128       <code>__setattr__</code>,
    129       <code>__sizeof__</code>,
    130       <code>__str__</code>,
    131       <code>__subclasshook__</code>
    132       </p>
    133     </td>
    134   </tr>
    135 </table>
    136 <!-- ==================== PROPERTIES ==================== -->
    137 <a name="section-Properties"></a>
    138 <table class="summary" border="1" cellpadding="3"
    139        cellspacing="0" width="100%" bgcolor="white">
    140 <tr bgcolor="#70b0f0" class="table-header">
    141   <td colspan="2" class="table-header">
    142     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    143       <tr valign="top">
    144         <td align="left"><span class="table-header">Properties</span></td>
    145         <td align="right" valign="top"
    146          ><span class="options">[<a href="#section-Properties"
    147          class="privatelink" onclick="toggle_private();"
    148          >hide private</a>]</span></td>
    149       </tr>
    150     </table>
    151   </td>
    152 </tr>
    153   <tr>
    154     <td colspan="2" class="summary">
    155     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    156       <code>__class__</code>
    157       </p>
    158     </td>
    159   </tr>
    160 </table>
    161 <!-- ==================== METHOD DETAILS ==================== -->
    162 <a name="section-MethodDetails"></a>
    163 <table class="details" border="1" cellpadding="3"
    164        cellspacing="0" width="100%" bgcolor="white">
    165 <tr bgcolor="#70b0f0" class="table-header">
    166   <td colspan="2" class="table-header">
    167     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    168       <tr valign="top">
    169         <td align="left"><span class="table-header">Method Details</span></td>
    170         <td align="right" valign="top"
    171          ><span class="options">[<a href="#section-MethodDetails"
    172          class="privatelink" onclick="toggle_private();"
    173          >hide private</a>]</span></td>
    174       </tr>
    175     </table>
    176   </td>
    177 </tr>
    178 </table>
    179 <a name="__init__"></a>
    180 <div>
    181 <table class="details" border="1" cellpadding="3"
    182        cellspacing="0" width="100%" bgcolor="white">
    183 <tr><td>
    184   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    185   <tr valign="top"><td>
    186   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
    187         <span class="sig-arg">message_number</span>,
    188         <span class="sig-arg">state</span>,
    189         <span class="sig-arg">resource_uri</span>,
    190         <span class="sig-arg">resource_id</span>)</span>
    191     <br /><em class="fname">(Constructor)</em>
    192   </h3>
    193   </td><td align="right" valign="top"
    194     ><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Notification.__init__">source&nbsp;code</a></span>&nbsp;
    195     </td>
    196   </tr></table>
    197   
    198   <pre class="literalblock">
    199 Notification constructor.
    200 
    201 Args:
    202   message_number: int, The unique id number of this notification.
    203   state: str, The state of the resource being monitored. Can be one
    204     of &quot;exists&quot;, &quot;not_exists&quot;, or &quot;sync&quot;.
    205   resource_uri: str, The address of the resource being monitored.
    206   resource_id: str, The identifier of the watched resource.
    207 
    208 </pre>
    209   <dl class="fields">
    210     <dt>Decorators:</dt>
    211     <dd><ul class="nomargin-top">
    212         <li><code>@util.positional(5)</code></li>
    213     </ul></dd>
    214     <dt>Overrides:
    215         object.__init__
    216     </dt>
    217   </dl>
    218 </td></tr></table>
    219 </div>
    220 <br />
    221 <!-- ==================== NAVIGATION BAR ==================== -->
    222 <table class="navbar" border="0" width="100%" cellpadding="0"
    223        bgcolor="#a0c0ff" cellspacing="0">
    224   <tr valign="middle">
    225   <!-- Home link -->
    226       <th>&nbsp;&nbsp;&nbsp;<a
    227         href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    228 
    229   <!-- Tree link -->
    230       <th>&nbsp;&nbsp;&nbsp;<a
    231         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    232 
    233   <!-- Index link -->
    234       <th>&nbsp;&nbsp;&nbsp;<a
    235         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    236 
    237   <!-- Help link -->
    238       <th>&nbsp;&nbsp;&nbsp;<a
    239         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    240 
    241       <th class="navbar" width="100%"></th>
    242   </tr>
    243 </table>
    244 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    245   <tr>
    246     <td align="left" class="footer">
    247     Generated by Epydoc 3.0.1 on Mon Jun  5 13:38:39 2017
    248     </td>
    249     <td align="right" class="footer">
    250       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    251         >http://epydoc.sourceforge.net</a>
    252     </td>
    253   </tr>
    254 </table>
    255 
    256 <script type="text/javascript">
    257   <!--
    258   // Private objects are initially displayed (because if
    259   // javascript is turned off then we want them to be
    260   // visible); but by default, we want to hide them.  So hide
    261   // them unless we have a cookie that says to show them.
    262   checkCookie();
    263   // -->
    264 </script>
    265 </body>
    266 </html>
    267