@ThreadRestricted(value="constructor") public final class DiffFeedWAP extends Call
http://reluk.ca:8080/v/wap?wCall=hHarvest&hPoll=Sys/p/sandbox&hUser=Jill-ProviderNet&hStartDate=1330969452&wPretty
These are the specific parameters for the cache engine API. See also the general parameters for the web API. The examples shown below assume a call prefix of 'h', but the actual prefix depends on the wCall request parameter. Newest are first in the returned JSON Array.
Key | Value | Default |
---|---|---|
hPoll | Names the poll. | Empty, optional item. |
hUser | Specify 'hUser=Jim-MailCom' to request messages from a specific user(s). | Empty, optional item. |
hId | Specify 'hId=1234' to only request messages newer than this serial. This allows you to update a list by only fetching newer slices. | Empty, optional item. |
The response includes the following components. These are shown in JSON format, with explanatory comments:
{ "bite": [ // bites in order of sent date, newest first { // diff messages "difference": { "key": KEY }, "message": { "content": "SUMMARY", "location": "WEB-URL", "sentDate": "SENT-DATE"; } "poll": "POLLNAME" "persons": [ { ... "username": "VOTERMAILISHUSERNAME", ... }, { ... "username": "CANDIDATEMAILISHUSERNAME", ... } ], }, // and so on, up to maximum server side provided messages or hSize ] }
Modifier and Type | Field and Description |
---|---|
static String |
CALL_TYPE
The name to use in the
wCall query parameter, which is * *
"DiffFeed" . |
Constructor and Description |
---|
DiffFeedWAP(String _prefix,
Requesting _req,
ResponseConfiguration _resConfig)
Constructs a DiffFeedWAP (former HarvestWAP).
|
Modifier and Type | Method and Description |
---|---|
void |
respond(Responding res)
Method implementing the servlet response.
|
public static final String CALL_TYPE
wCall
query parameter, which is * *
"DiffFeed" . For example: wCall=hHarvest
.public DiffFeedWAP(String _prefix, Requesting _req, ResponseConfiguration _resConfig) throws HTTPRequestException
_prefix
- _req
- _resConfig
- HTTPRequestException
public void respond(Responding res) throws IOException
respond
in class Call
IOException