import "Notes.idl";
Public Member Functions |
void | get (out NoteList list, out long totalItems, in kerio::web::KIdList folderIds, in kerio::web::SearchQuery query) |
void | getById (out kerio::web::ErrorList errors, out NoteList result, in kerio::web::KIdList ids) |
void | remove (out kerio::web::ErrorList errors, in kerio::web::KIdList ids) |
void | copy (out kerio::web::ErrorList errors, out CreateResultList result, in kerio::web::KIdList ids, in kerio::web::KId folder) |
void | create (out kerio::web::ErrorList errors, out CreateResultList result, in NoteList notes) |
void | set (out kerio::web::ErrorList errors, out SetResultList result, in NoteList notes) |
void | move (out kerio::web::ErrorList errors, out CreateResultList result, in kerio::web::KIdList ids, in kerio::web::KId folder) |
Detailed Description
Member Function Documentation
void kerio::jsonapi::webmail::notes::Notes::copy |
( |
out kerio::web::ErrorList |
errors, |
|
|
out CreateResultList |
result, |
|
|
in kerio::web::KIdList |
ids, |
|
|
in kerio::web::KId |
folder |
|
) |
| |
Copy existing notes to folder
- Parameters
-
errors | - error message list |
ids | - list of global identifiers of notes to be copied |
folder | - target folder |
void kerio::jsonapi::webmail::notes::Notes::create |
( |
out kerio::web::ErrorList |
errors, |
|
|
out CreateResultList |
result, |
|
|
in NoteList |
notes |
|
) |
| |
Create notes.
- Parameters
-
errors | - list of notes that failed on creation |
result | - particular results for all items |
notes | - list of notes to be created |
void kerio::jsonapi::webmail::notes::Notes::get |
( |
out NoteList |
list, |
|
|
out long |
totalItems, |
|
|
in kerio::web::KIdList |
folderIds, |
|
|
in kerio::web::SearchQuery |
query |
|
) |
| |
Get a list of notes.
- Parameters
-
list | - all found notes |
totalItems | - number of notes found if there is no limit |
folderIds | - list of global identifiers of folders to be listed. |
query | - query attributes and limits |
void kerio::jsonapi::webmail::notes::Notes::getById |
( |
out kerio::web::ErrorList |
errors, |
|
|
out NoteList |
result, |
|
|
in kerio::web::KIdList |
ids |
|
) |
| |
Get an note.
- Parameters
-
errors | - list of errors |
result | - found notes |
ids | - global identifiers of requested notes |
void kerio::jsonapi::webmail::notes::Notes::move |
( |
out kerio::web::ErrorList |
errors, |
|
|
out CreateResultList |
result, |
|
|
in kerio::web::KIdList |
ids, |
|
|
in kerio::web::KId |
folder |
|
) |
| |
Move existing notes to folder
- Parameters
-
errors | - error message list |
ids | - list of global identifiers of notes to be moved |
folder | - target folder |
void kerio::jsonapi::webmail::notes::Notes::remove |
( |
out kerio::web::ErrorList |
errors, |
|
|
in kerio::web::KIdList |
ids |
|
) |
| |
Remove a list of notes.
- Parameters
-
errors | - list of notes that failed to remove |
ids | - list of global identifiers of notes to be removed |
void kerio::jsonapi::webmail::notes::Notes::set |
( |
out kerio::web::ErrorList |
errors, |
|
|
out SetResultList |
result, |
|
|
in NoteList |
notes |
|
) |
| |
Set notes.
- Parameters
-
errors | - error message list |
events | - modifications of notes. |
The documentation for this interface was generated from the following file: