import "Changes.idl";
Public Member Functions |
void | get (out ChangeList list, out SyncKey syncKey, in SyncKey lastSyncKey, in long timeout) |
void | getAccount (out ChangeList list, out AccountSyncKey asyncKey, in AccountSyncKey lastAsyncKey, in kerio::web::KIdList folderIds) |
void | killRequest (in SyncKey lastSyncKey) |
void | getFolder (out ChangeList list, out Watermark syncKey, in kerio::web::KId folderId, in Watermark lastSyncKey) |
void | getSyncKey (out SyncKey syncKey) |
void | getAccountSyncKey (out AccountSyncKey asyncKey, in kerio::web::KId mailboxId) |
void | getFolderSyncKey (out Watermark syncKey, in kerio::web::KId folderId) |
Detailed Description
Member Function Documentation
void kerio::jsonapi::webmail::changes::Changes::get |
( |
out ChangeList |
list, |
|
|
out SyncKey |
syncKey, |
|
|
in SyncKey |
lastSyncKey, |
|
|
in long |
timeout |
|
) |
| |
Get changes for all folders on this server. Is permitted only one long-poll request with the same 'lastSyncKey'.
- Parameters
-
list | - all found changes |
syncKey | - new watermark |
lastSyncKey | - last watermark |
timeout | - max time to wait for new changes. If value is zero response is returned imediately. |
void kerio::jsonapi::webmail::changes::Changes::getAccount |
( |
out ChangeList |
list, |
|
|
out AccountSyncKey |
asyncKey, |
|
|
in AccountSyncKey |
lastAsyncKey, |
|
|
in kerio::web::KIdList |
folderIds |
|
) |
| |
Get changes for all accessible folders of particular user or resource.
- Parameters
-
list | - all found changes |
asyncKey | - new watermark |
lastAsyncKey | - last watermark |
folderIds | - IDs of subcribed folders |
void kerio::jsonapi::webmail::changes::Changes::getAccountSyncKey |
( |
out AccountSyncKey |
asyncKey, |
|
|
in kerio::web::KId |
mailboxId |
|
) |
| |
Get actual watermark.
- Parameters
-
watermark | - actual watermark |
pricipalId | - ID of a user or a resurce |
void kerio::jsonapi::webmail::changes::Changes::getFolder |
( |
out ChangeList |
list, |
|
|
out Watermark |
syncKey, |
|
|
in kerio::web::KId |
folderId, |
|
|
in Watermark |
lastSyncKey |
|
) |
| |
Get changes in a folder.
- Parameters
-
list | - all found changes |
syncKey | - new last synckey (watermark) |
folderId | - folder from which we want get item changes |
lastSyncKey | - last synckey (watermark) |
void kerio::jsonapi::webmail::changes::Changes::getFolderSyncKey |
( |
out Watermark |
syncKey, |
|
|
in kerio::web::KId |
folderId |
|
) |
| |
Get actual sync key for a folder.
- Parameters
-
syncKey | - actual synckey (watermark) for folder |
folderId | - wanted folder |
void kerio::jsonapi::webmail::changes::Changes::getSyncKey |
( |
out SyncKey |
syncKey | ) |
|
Get actual watermark.
- Parameters
-
watermark | - actual watermark |
void kerio::jsonapi::webmail::changes::Changes::killRequest |
( |
in SyncKey |
lastSyncKey | ) |
|
Kill current running Changes.get's request. It supposed that timeout was specified > 0.
- Parameters
-
lastSyncKey | - last watermark |
The documentation for this interface was generated from the following file: