358
edits
Ommina
Joined 21 September 2007
no edit summary
No edit summary |
No edit summary |
||
| Line 11: | Line 11: | ||
Note that, while a user can subscribe to multiple 'new file' events (see [[Notifications|notifications]]), at present, the UDP API only supports notifications of new files by anime. New files by group, or new files by producer, are NOT presently supported. Just the same, keeping in mind that the API is designed to potentially support such notifications in the future will help in understanding why some of the commands are structured the way they are. | Note that, while a user can subscribe to multiple 'new file' events (see [[Notifications|notifications]]), at present, the UDP API only supports notifications of new files by anime. New files by group, or new files by producer, are NOT presently supported. Just the same, keeping in mind that the API is designed to potentially support such notifications in the future will help in understanding why some of the commands are structured the way they are. | ||
=== Introduction === | |||
Clients that wish to receive notifications have two routes available to them. They are by no means mutually exclusive and selecting one does not imply a client is unable to use commands from another. | Clients that wish to receive notifications have two routes available to them. They are by no means mutually exclusive and selecting one does not imply a client is unable to use commands from another. | ||
| Line 28: | Line 30: | ||
* Use NOTIFYGET to receive a notification, suppling the ID provided by NOTIFYLIST | * Use NOTIFYGET to receive a notification, suppling the ID provided by NOTIFYLIST | ||
* Use NOTIFYACK to acknowledge a notification, suppling the ID provided by NOTIFYLIST (if desired) | * Use NOTIFYACK to acknowledge a notification, suppling the ID provided by NOTIFYLIST (if desired) | ||
{{eyecatch|NOTE|The ID supplied by NOTIFYLIST will be the ID of the affected notification type. Since, at present, only the anime type is supported, this value is always an aid. In the future, it may represent a group or producer ID. In these cases, the str type value with indicate what entity the ID represents.}} | {{eyecatch|NOTE|The ID supplied by NOTIFYLIST will be the ID of the affected notification type. Since, at present, only the anime type is supported, this value is always an aid. In the future, it may represent a group or producer ID. In these cases, the str type value with indicate what entity the ID represents.}} | ||
| Line 44: | Line 47: | ||
* Use NOTIFYGET to receive a notification, suppling the relid provided by NOTIFICATION (NOT the packet ID) | * Use NOTIFYGET to receive a notification, suppling the relid provided by NOTIFICATION (NOT the packet ID) | ||
* Use NOTIFYACK to acknowledge a notification, suppling the relid provided by NOTIFICATION (if desired) | * Use NOTIFYACK to acknowledge a notification, suppling the relid provided by NOTIFICATION (if desired) | ||
It is probably a good idea to use tags to separate NOTIFICATIONs from the other communication. NOTIFICATIONs will '''never''' have tags. | It is probably a good idea to use tags to separate NOTIFICATIONs from the other communication. NOTIFICATIONs will '''never''' have tags. | ||