Overview | Service | Command |
Query WaitSet
This API dumps the internal state of all active waitsets. It is intended for debugging use only and should not be
used for production uses. This API is not guaranteed to be stable between releases in any way and might be
removed without warning.
<QueryWaitSetResponse id="WAITSETID" defTypes="DEFAULT_TYPES" owner="WAITSET_OWNER_ACCOUNT_ID" ld="LAST_ACCESS_DATE" cbSeqNo="SEQNO_OF_CB" currentSeqNo="CURRENT_SEQUENCE_NUMBER"> [<ready accounts="comma-separated list of account IDs"/>]? [<session types="TYPES" account="ACCOUNT_ID"> [ <WaitSetSession interestMask="BITMASK" highestChangeId="MBOX_CHANGE_ID" lastAccessTime="LAST_ACCESS_TIME" creationTime="CREATION_TIME"/> ]? </session>]* </QueryWaitSetResponse>
<QueryWaitSetResponse id="WAITSETID" defTypes="DEFAULT_TYPES" owner="WAITSET_OWNER_ACCOUNT_ID" ld="LAST_ACCESS_DATE" nextSeqNo="NEXT_SEQNO" cbSeqNo="CB_SEQNO" currentSeqNo="CURRENT_SEQNO" > [<buffered> [<commit aid="ACCOUNT_ID" cid="COMMIT_ID"/>]* // only during WS creation before first WaitSetRequest ]? [<ready accounts="comma-separated list of account IDs"/>]? </QueryWaitSetResponse>
Authorization token required | true |
Admin Authorization token required | true |
<QueryWaitSetRequest [waitSet="{waitset-id}"] /> ## QueryWaitSetRequest
The following table describes elements and attributes you can define within a
<QueryWaitSetRequest>
element:
XPath | Required / Optional | Description |
@waitSet | Optional (0 or 1) | Type:String WaitSet ID |
<QueryWaitSetResponse> ## QueryWaitSetResponse
(<waitSet id="{waitset-id}" owner="{waitset-owner-acct-id}" defTypes="{default-interests}"
ld="{last-access-date} (long)" [cbSeqNo="{cb-seq-no}"] [currentSeqNo="{curr-seq-no}"]
[nextSeqNo="{next-seq-no}"]> ## WaitSetInfo
<errors>
(<error id="..." type="..." /> ## IdAndType)*
</errors>
<ready accounts="{comma-sep-account-id-list}" /> ## AccountsAttrib
<buffered>
(<commit aid="{account-id}" cid="{commit-id}" /> ## BufferedCommitInfo)*
</buffered>
(<session account="{account-id}" types="{interests-types}" [token="{last-known-sync-token}"]
[mboxSyncToken="{mailbox-sync-token} (Integer)"]
[mboxSyncTokenDiff="{mboxSyncTokenDiff} (Integer)"]> ## SessionForWaitSet
<WaitSetSession interestMask="{bitmask}" highestChangeId="{mbox-change-id} (int)"
lastAccessTime="{last-access-time} (long)" creationTime="{creation-time} (long)"
sessionId="{session-id}" [token="{sync-token}"] /> ## WaitSetSessionInfo
</session>)*
</waitSet>)*
</QueryWaitSetResponse>
The following table describes elements and attributes you can define within a
<QueryWaitSetResponse>
element:
XPath | Required / Optional | Description | ||||||||||||||
/waitSet | Optional (0 or more) | Information about WaitSets | ||||||||||||||
/waitSet@id | Required (only 1) | Type:String WaitSet ID |
||||||||||||||
/waitSet@owner | Required (only 1) | Type:String WaitSet owner account ID |
||||||||||||||
/waitSet@defTypes | Required (only 1) | Type:String Default interest types: comma-separated list. Currently:
|
||||||||||||||
/waitSet@ld | Required (only 1) | Type:long Last access date |
||||||||||||||
/waitSet@cbSeqNo | Optional (0 or 1) | Type:String CB sequence number |
||||||||||||||
/waitSet@currentSeqNo | Optional (0 or 1) | Type:String Current sequence number |
||||||||||||||
/waitSet@nextSeqNo | Optional (0 or 1) | Type:String Next sequence number |
||||||||||||||
/waitSet/errors | Required (only 1) | |||||||||||||||
/waitSet/errors/error | Optional (0 or more) | |||||||||||||||
/waitSet/errors/error@id | Required (only 1) | Type:String ID |
||||||||||||||
/waitSet/errors/error@type | Required (only 1) | Type:String Type |
||||||||||||||
/waitSet/ready | Optional (0 or 1) | Comma separated list of account IDs | ||||||||||||||
/waitSet/ready@accounts | Required (only 1) | Type:String Comma separated list of account IDs |
||||||||||||||
/waitSet/buffered | Required (only 1) | |||||||||||||||
/waitSet/buffered/commit | Optional (0 or more) | |||||||||||||||
/waitSet/buffered/commit@aid | Required (only 1) | Type:String Account ID |
||||||||||||||
/waitSet/buffered/commit@cid | Required (only 1) | Type:String Commit ID |
||||||||||||||
/waitSet/session | Optional (0 or more) | Session information | ||||||||||||||
/waitSet/session@account | Required (only 1) | Type:String Account ID |
||||||||||||||
/waitSet/session@types | Required (only 1) | Type:String Interest types - Either all or some combination of the letters: mcatd Which stand for Message, Contact, Appointment, Task and Document respectively |
||||||||||||||
/waitSet/session@token | Optional (0 or 1) | Type:String Last known sync token |
||||||||||||||
/waitSet/session@mboxSyncToken | Optional (0 or 1) | Type:Integer Mailbox sync token |
||||||||||||||
/waitSet/session@mboxSyncTokenDiff | Optional (0 or 1) | Type:Integer mboxSyncTokenDiff |
||||||||||||||
/waitSet/session/WaitSetSession | Optional (0 or 1) | WaitSet session Information | ||||||||||||||
/waitSet/session/WaitSetSession@interestMask | Required (only 1) | Type:String Interest bitmask |
||||||||||||||
/waitSet/session/WaitSetSession@highestChangeId | Required (only 1) | Type:int Mailbox change ID |
||||||||||||||
/waitSet/session/WaitSetSession@lastAccessTime | Required (only 1) | Type:long Last access time |
||||||||||||||
/waitSet/session/WaitSetSession@creationTime | Required (only 1) | Type:long Creation time |
||||||||||||||
/waitSet/session/WaitSetSession@sessionId | Required (only 1) | Type:String Session ID |
||||||||||||||
/waitSet/session/WaitSetSession@token | Optional (0 or 1) | Type:String Sync Token |