A watch is a way for a user to track updates to an object. Users create watches on individual
objects and can specify whether or not they want to be notified by email (or some other way)
each time the object is updated.
Three kinds of watch types are available:
- "Normal" watches are passive watches. This means the user doesn't get explicit
notifications of object updates, but will see that has been updated the next time
they visit.
- Email update watches send an email to the user whenever the object is updated. Typically,
this email message will include a link back to the online site, but messages are highly
configurable. Email notifications are disabled by default, but can be enabled through
the admin screens. Users will not receive email watch notifications for objects that they
post themselves, since doing so would be rather pointless.
- Batch email update watches are the same as normal email watch updates except that the email
is sent to the user only periodically and include all the updates that have occurred since
the last email was sent.
Type Template
<...>
<expirable>xs:boolean</expirable>
<objectID>xs:long</objectID>
<objectType>xs:int</objectType>
<userID>xs:long</userID>
<watchType>xs:int</watchType>
<...>Note: Element descriptions are split into information that's
relevant when you're creating an instance of this type and information
relevant when you're receiving an instance of it. Occasionally these
will differ.
Elements
| Element |
Description |
| expirable
|
- Setting
- Sets whether this watch is expirable or not.
- Getting
- Returns whether this watch is expirable or not.
|
| objectID
|
- Setting
- Getting
- Returns the object ID of the object being watched.
|
| objectType
|
- Setting
- Getting
- Returns the object type of the object being watched.
|
| userID
|
- Setting
- Getting
- Returns the if of the user who is associated with this watch.
|
| watchType
|
- Setting
- Sets the watch type.
- Getting
- Returns the type of the watch.
|