blob: 2960e086f3be2593a18b33b86a19f3ae891cd3a6 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<?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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070060<pre class="base-tree">
61object --+
62 |
63 <strong class="uidshort">Notification</strong>
64</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -070065
John Asmuth614db982014-04-24 15:46:26 -040066<hr />
67<pre class="literalblock">
68A Notification from a Channel.
69
70Notifications are not usually constructed directly, but are returned
71from functions like notification_from_headers().
72
73Attributes:
74 message_number: int, The unique id number of this notification.
75 state: str, The state of the resource being monitored.
76 uri: str, The address of the resource being monitored.
77 resource_id: str, The unique identifier of the version of the resource at
78 this event.
79
80</pre>
81
82<!-- ==================== INSTANCE METHODS ==================== -->
83<a name="section-InstanceMethods"></a>
84<table class="summary" border="1" cellpadding="3"
85 cellspacing="0" width="100%" bgcolor="white">
86<tr bgcolor="#70b0f0" class="table-header">
87 <td colspan="2" class="table-header">
88 <table border="0" cellpadding="0" cellspacing="0" width="100%">
89 <tr valign="top">
90 <td align="left"><span class="table-header">Instance Methods</span></td>
91 <td align="right" valign="top"
92 ><span class="options">[<a href="#section-InstanceMethods"
93 class="privatelink" onclick="toggle_private();"
94 >hide private</a>]</span></td>
95 </tr>
96 </table>
97 </td>
98</tr>
99<tr>
100 <td width="15%" align="right" valign="top" class="summary">
101 <span class="summary-type">&nbsp;</span>
102 </td><td class="summary">
103 <table width="100%" cellpadding="0" cellspacing="0" border="0">
104 <tr>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105 <td><span class="summary-sig"><a href="googleapiclient.channel.Notification-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">*args</span>,
106 <span class="summary-sig-arg">**kwargs</span>)</span><br />
John Asmuth614db982014-04-24 15:46:26 -0400107 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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700186 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">*args</span>,
187 <span class="sig-arg">**kwargs</span>)</span>
John Asmuth614db982014-04-24 15:46:26 -0400188 <br /><em class="fname">(Constructor)</em>
189 </h3>
190 </td><td align="right" valign="top"
191 ><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Notification.__init__">source&nbsp;code</a></span>&nbsp;
192 </td>
193 </tr></table>
194
195 <pre class="literalblock">
196Notification constructor.
197
198Args:
199 message_number: int, The unique id number of this notification.
200 state: str, The state of the resource being monitored. Can be one
201 of &quot;exists&quot;, &quot;not_exists&quot;, or &quot;sync&quot;.
202 resource_uri: str, The address of the resource being monitored.
203 resource_id: str, The identifier of the watched resource.
204
205</pre>
206 <dl class="fields">
207 <dt>Decorators:</dt>
208 <dd><ul class="nomargin-top">
209 <li><code>@util.positional(5)</code></li>
210 </ul></dd>
211 <dt>Overrides:
212 object.__init__
213 </dt>
214 </dl>
215</td></tr></table>
216</div>
217<br />
218<!-- ==================== NAVIGATION BAR ==================== -->
219<table class="navbar" border="0" width="100%" cellpadding="0"
220 bgcolor="#a0c0ff" cellspacing="0">
221 <tr valign="middle">
222 <!-- Home link -->
223 <th>&nbsp;&nbsp;&nbsp;<a
224 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
225
226 <!-- Tree link -->
227 <th>&nbsp;&nbsp;&nbsp;<a
228 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
229
230 <!-- Index link -->
231 <th>&nbsp;&nbsp;&nbsp;<a
232 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
233
234 <!-- Help link -->
235 <th>&nbsp;&nbsp;&nbsp;<a
236 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
237
238 <th class="navbar" width="100%"></th>
239 </tr>
240</table>
241<table border="0" cellpadding="0" cellspacing="0" width="100%%">
242 <tr>
243 <td align="left" class="footer">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700244 Generated by Epydoc 3.0.1 on Fri Oct 2 20:46:22 2020
John Asmuth614db982014-04-24 15:46:26 -0400245 </td>
246 <td align="right" class="footer">
247 <a target="mainFrame" href="http://epydoc.sourceforge.net"
248 >http://epydoc.sourceforge.net</a>
249 </td>
250 </tr>
251</table>
252
253<script type="text/javascript">
254 <!--
255 // Private objects are initially displayed (because if
256 // javascript is turned off then we want them to be
257 // visible); but by default, we want to hide them. So hide
258 // them unless we have a cookie that says to show them.
259 checkCookie();
260 // -->
261</script>
262</body>
263</html>