/usr/share/doc/python-diaspy-doc/notifications.html is in python-diaspy-doc 0.5.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | <h4><code>Notifications()</code> object</h4>
<p>In order to get list of notifications use <code>diaspy.notifications.Notifications()</code> object.
It support iteration and indexing.</p>
<p>When creating new instance of <code>Notifications</code> only <code>Connection</code> object is needed.</p>
<h4>Methods</h4>
<h5><code>last()</code></h5>
<p>This method will return you last five notifications.</p>
<h5><code>get()</code></h5>
<p>This is slightly more advanced then <code>last()</code>. It allows you to specify how many
notifications per page you want to get and which page you want to recieve.</p>
<hr />
<h4><code>Notification()</code> model</h4>
<p>Single notification (it should be obvious that it requires object of its own) is located in
<code>diaspy.models.Notification()</code>. It has several methods you can use.</p>
<h5>1. <code>who()</code></h5>
<p>This method will return list of guids of the users who caused you to get this notification.</p>
<h5>2. <code>when()</code></h5>
<p>This method will return UTC time when you get the notification.</p>
<h5>3. <code>mark()</code></h5>
<p>To mark notification as <code>read</code> or <code>unread</code>. It has one parameter - <code>unread</code> which is boolean.</p>
<p> </p>
<p>Also, you can use <code>str()</code> and <code>repr()</code> on the <code>Notification()</code> and you will get nice
string.</p>
<hr />
<h6>Manual for <code>diaspy</code>, written by Marek Marecki</h6>
|