Line data Source code
1 : /*
2 : * Packge : Wilt
3 : * Author : S. Hamblett <steve.hamblett@linux.com>
4 : * Date : 04/06/2013
5 : * Copyright : S.Hamblett@OSCF
6 : *
7 : * Change notification parameters, defaults taken from the CouchDB API documents.
8 : *
9 : */
10 :
11 : part of wilt;
12 :
13 : class WiltChangeNotificationParameters {
14 : /// Since
15 : ///
16 : /// Start the results from the change immediately after the given sequence number
17 : int _since = 0;
18 1 : int get since => _since;
19 0 : set since(int value) => _since = value;
20 :
21 : /// Descending
22 : ///
23 : /// Return the change results in descending sequence order (most recent change first)
24 : bool _descending = false;
25 1 : bool get descending => _descending;
26 0 : set descending(bool on) => _descending = on;
27 :
28 : /// Heartbeat
29 : ///
30 : /// Period in milliseconds between notification requests to CouchDB
31 : /// Be sensible with this, 1 second between requests is a good minimum.
32 : int _heartbeat = 2000;
33 1 : int get heartbeat => _heartbeat;
34 0 : set heartbeat(int period) => _heartbeat = period;
35 :
36 : /// Include documents
37 : ///
38 : /// Include the associated document with each result. If there are conflicts,
39 : /// only the winning revision is returned
40 : bool _includeDocs = false;
41 1 : bool get includeDocs => _includeDocs;
42 1 : set includeDocs(bool include) => _includeDocs = include;
43 :
44 : /// Include attachments
45 : ///
46 : /// Include any associated document attachments with each result.
47 : /// This will retrieve the body of the attachment in Base64 format
48 : /// as well as the stub data that is normally supplied.
49 : bool _includeAttachments = false;
50 1 : bool get includeAttachments => _includeAttachments;
51 1 : set includeAttachments(bool include) => _includeAttachments = include;
52 : }
|