blob: 0dd3703db122b22d8310fbfa3e4ccdde6fe4dc7f [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>
60<center>
61<center> <map id="uml_class_diagram_for_googleap_2" name="uml_class_diagram_for_googleap_2">
Craig Citro065b5302014-08-14 00:47:23 -070062<area shape="rect" id="node1_1" href="googleapiclient.channel.Notification-class.html#__init__" title="Notification constructor." alt="" coords="17,36,407,55"/>
63<area shape="rect" id="node1" href="googleapiclient.channel.Notification-class.html" title="A Notification from a Channel." alt="" coords="5,5,419,61"/>
John Asmuth614db982014-04-24 15:46:26 -040064</map>
65 <img src="uml_class_diagram_for_googleap_2.gif" alt='' usemap="#uml_class_diagram_for_googleap_2" ismap="ismap" class="graph-without-title" />
66</center>
67</center>
68<hr />
69<pre class="literalblock">
70A Notification from a Channel.
71
72Notifications are not usually constructed directly, but are returned
73from functions like notification_from_headers().
74
75Attributes:
76 message_number: int, The unique id number of this notification.
77 state: str, The state of the resource being monitored.
78 uri: str, The address of the resource being monitored.
79 resource_id: str, The unique identifier of the version of the resource at
80 this event.
81
82</pre>
83
84<!-- ==================== INSTANCE METHODS ==================== -->
85<a name="section-InstanceMethods"></a>
86<table class="summary" border="1" cellpadding="3"
87 cellspacing="0" width="100%" bgcolor="white">
88<tr bgcolor="#70b0f0" class="table-header">
89 <td colspan="2" class="table-header">
90 <table border="0" cellpadding="0" cellspacing="0" width="100%">
91 <tr valign="top">
92 <td align="left"><span class="table-header">Instance Methods</span></td>
93 <td align="right" valign="top"
94 ><span class="options">[<a href="#section-InstanceMethods"
95 class="privatelink" onclick="toggle_private();"
96 >hide private</a>]</span></td>
97 </tr>
98 </table>
99 </td>
100</tr>
101<tr>
102 <td width="15%" align="right" valign="top" class="summary">
103 <span class="summary-type">&nbsp;</span>
104 </td><td class="summary">
105 <table width="100%" cellpadding="0" cellspacing="0" border="0">
106 <tr>
107 <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>,
108 <span class="summary-sig-arg">message_number</span>,
109 <span class="summary-sig-arg">state</span>,
110 <span class="summary-sig-arg">resource_uri</span>,
111 <span class="summary-sig-arg">resource_id</span>)</span><br />
112 Notification constructor.</td>
113 <td align="right" valign="top">
114 <span class="codelink"><a href="googleapiclient.channel-pysrc.html#Notification.__init__">source&nbsp;code</a></span>
115
116 </td>
117 </tr>
118 </table>
119
120 </td>
121 </tr>
122 <tr>
123 <td colspan="2" class="summary">
124 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
125 <code>__delattr__</code>,
126 <code>__format__</code>,
127 <code>__getattribute__</code>,
128 <code>__hash__</code>,
129 <code>__new__</code>,
130 <code>__reduce__</code>,
131 <code>__reduce_ex__</code>,
132 <code>__repr__</code>,
133 <code>__setattr__</code>,
134 <code>__sizeof__</code>,
135 <code>__str__</code>,
136 <code>__subclasshook__</code>
137 </p>
138 </td>
139 </tr>
140</table>
141<!-- ==================== PROPERTIES ==================== -->
142<a name="section-Properties"></a>
143<table class="summary" border="1" cellpadding="3"
144 cellspacing="0" width="100%" bgcolor="white">
145<tr bgcolor="#70b0f0" class="table-header">
146 <td colspan="2" class="table-header">
147 <table border="0" cellpadding="0" cellspacing="0" width="100%">
148 <tr valign="top">
149 <td align="left"><span class="table-header">Properties</span></td>
150 <td align="right" valign="top"
151 ><span class="options">[<a href="#section-Properties"
152 class="privatelink" onclick="toggle_private();"
153 >hide private</a>]</span></td>
154 </tr>
155 </table>
156 </td>
157</tr>
158 <tr>
159 <td colspan="2" class="summary">
160 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
161 <code>__class__</code>
162 </p>
163 </td>
164 </tr>
165</table>
166<!-- ==================== METHOD DETAILS ==================== -->
167<a name="section-MethodDetails"></a>
168<table class="details" border="1" cellpadding="3"
169 cellspacing="0" width="100%" bgcolor="white">
170<tr bgcolor="#70b0f0" class="table-header">
171 <td colspan="2" class="table-header">
172 <table border="0" cellpadding="0" cellspacing="0" width="100%">
173 <tr valign="top">
174 <td align="left"><span class="table-header">Method Details</span></td>
175 <td align="right" valign="top"
176 ><span class="options">[<a href="#section-MethodDetails"
177 class="privatelink" onclick="toggle_private();"
178 >hide private</a>]</span></td>
179 </tr>
180 </table>
181 </td>
182</tr>
183</table>
184<a name="__init__"></a>
185<div>
186<table class="details" border="1" cellpadding="3"
187 cellspacing="0" width="100%" bgcolor="white">
188<tr><td>
189 <table width="100%" cellpadding="0" cellspacing="0" border="0">
190 <tr valign="top"><td>
191 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
192 <span class="sig-arg">message_number</span>,
193 <span class="sig-arg">state</span>,
194 <span class="sig-arg">resource_uri</span>,
195 <span class="sig-arg">resource_id</span>)</span>
196 <br /><em class="fname">(Constructor)</em>
197 </h3>
198 </td><td align="right" valign="top"
199 ><span class="codelink"><a href="googleapiclient.channel-pysrc.html#Notification.__init__">source&nbsp;code</a></span>&nbsp;
200 </td>
201 </tr></table>
202
203 <pre class="literalblock">
204Notification constructor.
205
206Args:
207 message_number: int, The unique id number of this notification.
208 state: str, The state of the resource being monitored. Can be one
209 of &quot;exists&quot;, &quot;not_exists&quot;, or &quot;sync&quot;.
210 resource_uri: str, The address of the resource being monitored.
211 resource_id: str, The identifier of the watched resource.
212
213</pre>
214 <dl class="fields">
215 <dt>Decorators:</dt>
216 <dd><ul class="nomargin-top">
217 <li><code>@util.positional(5)</code></li>
218 </ul></dd>
219 <dt>Overrides:
220 object.__init__
221 </dt>
222 </dl>
223</td></tr></table>
224</div>
225<br />
226<!-- ==================== NAVIGATION BAR ==================== -->
227<table class="navbar" border="0" width="100%" cellpadding="0"
228 bgcolor="#a0c0ff" cellspacing="0">
229 <tr valign="middle">
230 <!-- Home link -->
231 <th>&nbsp;&nbsp;&nbsp;<a
232 href="googleapiclient-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
233
234 <!-- Tree link -->
235 <th>&nbsp;&nbsp;&nbsp;<a
236 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
237
238 <!-- Index link -->
239 <th>&nbsp;&nbsp;&nbsp;<a
240 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
241
242 <!-- Help link -->
243 <th>&nbsp;&nbsp;&nbsp;<a
244 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
245
246 <th class="navbar" width="100%"></th>
247 </tr>
248</table>
249<table border="0" cellpadding="0" cellspacing="0" width="100%%">
250 <tr>
251 <td align="left" class="footer">
Craig Citroe633be12015-03-02 13:40:36 -0800252 Generated by Epydoc 3.0.1 on Mon Mar 2 13:38:41 2015
John Asmuth614db982014-04-24 15:46:26 -0400253 </td>
254 <td align="right" class="footer">
255 <a target="mainFrame" href="http://epydoc.sourceforge.net"
256 >http://epydoc.sourceforge.net</a>
257 </td>
258 </tr>
259</table>
260
261<script type="text/javascript">
262 <!--
263 // Private objects are initially displayed (because if
264 // javascript is turned off then we want them to be
265 // visible); but by default, we want to hide them. So hide
266 // them unless we have a cookie that says to show them.
267 checkCookie();
268 // -->
269</script>
270</body>
271</html>