vx_evt_account_archive_query_end
Reference the Vivox Core SDK API.
Read time 2 minutesLast updated 8 months ago
Presented when an account message archive query is completed. More...
#include <VxcEvents.h>Public Attributes
Name | |
|---|---|
| vx_evt_base_t | base The common properties for all events. |
| VX_HANDLE | account_handle The handle returned from a successful account login request. |
| char * | query_id The ID of the query in progress. |
| int | return_code The query result code. |
| int | status_code The query status code. |
| char * | first_id The first returned message ID. |
| char * | last_id The last returned message ID. |
| unsigned int | first_index The index of the first matching message reported with a vx_evt_account_archive_message event. |
| unsigned int | count The total number of messages matching the criteria specified in the [vx_req_account_archive_query] request. |
| char * | next_cursor A cursor pointing to the next page of results for pagination. |
Detailed Description
struct vx_evt_account_archive_query_end;
Presented when an account message archive query is completed.
There is one vx_evt_account_archive_query_end event for every query started with vx_req_account_archive_query request.
Public Attributes Documentation
variable base
vx_evt_base_t base;
The common properties for all events.
variable account_handle
VX_HANDLE account_handle;
The handle returned from a successful account login request.
variable query_id
char * query_id;
The ID of the query in progress.
This ID is returned for a successfully started query in a vx_resp_account_archive_query response.
variable return_code
int return_code;
The query result code.
This is similar to a response result_code.
variable status_code
int status_code;
The query status code.
This is similar to a response status_code.
variable first_id
char * first_id;
The first returned message ID.
This ID can be used for paging.
variable last_id
char * last_id;
The last returned message ID.
This ID can be used for paging.
variable first_index
unsigned int first_index;
The index of the first matching message reported with a vx_evt_account_archive_message event.
variable count
unsigned int count;
The total number of messages matching the criteria specified in the [vx_req_account_archive_query] request.
This is the total size of the result set.
variable next_cursor
char * next_cursor;
A cursor pointing to the next page of results for pagination.
The cursor is returned as a timestamp in ISO format.