[diaspy.git] / manual / notifications.markdown

#### `Notifications()` object

In order to get list of notifications use `diaspy.notifications.Notifications()` object. 
It support iteration and indexing.

When creating new instance of `Notifications` only `Connection` object is needed.

#### Methods

##### `last()`

This method will return you last five notifications.

##### `get()`

This is slightly more advanced then `last()`. It allows you to specify how many 
notifications per page you want to get and which page you want to recieve.

----

#### `Notification()` model

Single notification (it should be obvious that it requires object of its own) is located in 
`diaspy.models.Notification()`. It has several methods you can use.

##### 1. `who()`

This method will return list of guids of the users who caused you to get this notification.

##### 2. `when()`

This method will return UTC time when you get the notification.

##### 3. `mark()`

To mark notification as `read` or `unread`. It has one parameter - `unread` which is boolean.

&nbsp;

Also, you can use `str()` and `repr()` on the `Notification()` and you will get nice 
string.

----

###### Manual for `diaspy`, written by Marek Marecki
Commit	Line	Data
c8438f07 MM	1	#### `Notifications()` object
c8438f07 MM	2
178faa46	3	In order to get list of notifications use `diaspy.notifications.Notifications()` object.
c8438f07 MM	4	It support iteration and indexing.
c8438f07 MM	5
6d8d47ce MM	6	When creating new instance of `Notifications` only `Connection` object is needed.
	7
	8	#### Methods
	9
	10	##### `last()`
	11
	12	This method will return you last five notifications.
	13
	14	##### `get()`
	15
	16	This is slightly more advanced then `last()`. It allows you to specify how many
	17	notifications per page you want to get and which page you want to recieve.
	18
c8438f07 MM	19	----
	20
	21	#### `Notification()` model
178faa46 MM	22
178faa46 MM	23	Single notification (it should be obvious that it requires object of its own) is located in
c8438f07	24	`diaspy.models.Notification()`. It has several methods you can use.
178faa46	25
c8438f07	26	##### 1. `who()`
178faa46	27
19a4a78a	28	This method will return list of guids of the users who caused you to get this notification.
c8438f07 MM	29
c8438f07 MM	30	##### 2. `when()`
178faa46	31
c8438f07 MM	32	This method will return UTC time when you get the notification.
	33
	34	##### 3. `mark()`
	35
	36	To mark notification as `read` or `unread`. It has one parameter - `unread` which is boolean.
	37
	38
	39
	40	Also, you can use `str()` and `repr()` on the `Notification()` and you will get nice
	41	string.
	42
	43	----
178faa46	44
c8438f07	45	###### Manual for `diaspy`, written by Marek Marecki