vx_evt_session_archive_query_end
Reference the Vivox Core SDK API.
Read time 2 minutesLast updated a day ago
Module: Group Voice and Text Communications Presented when a channel history query is completed. More...
#include <VxcEvents.h>Public Attributes
Name | |
|---|---|
| vx_evt_base_t | base The common properties for all events. |
| VX_HANDLE | sessiongroup_handle The handle used in vx_req_sessiongroup_addsession. |
| VX_HANDLE | session_handle The handle returned from a successful session add 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_session_archive_message event. |
| unsigned int | count The total number of messages matching the criteria specified in the [vx_req_session_archive_query] request. |
| char * | next_cursor A timestamp cursor (ISO format) pointing to the next page of results. |
Detailed Description
Presented when a channel history query is completed. There is one vx_evt_session_archive_query_end event for every query started with a vx_req_session_archive_query request.struct vx_evt_session_archive_query_end;
Public Attributes Documentation
variable base
The common properties for all events.vx_evt_base_t base;
variable sessiongroup_handle
The handle used in vx_req_sessiongroup_addsession. See: vx_req_sessiongroup_addsessionVX_HANDLE sessiongroup_handle;
variable session_handle
The handle returned from a successful session add request. See: vx_req_sessiongroup_add_sessionVX_HANDLE session_handle;
variable query_id
The ID of the query in progress. This ID is returned for a successfully started query in a vx_resp_session_archive_query response.char * query_id;
variable return_code
The query result code. This is similar to a response result_code.int return_code;
variable status_code
The query status code. This is similar to a response status_code.int status_code;
variable first_id
The first returned message ID. This ID can be used for paging.char * first_id;
variable last_id
The last returned message ID. This ID can be used for paging.char * last_id;
variable first_index
The index of the first matching message reported with a vx_evt_session_archive_message event.unsigned int first_index;
variable count
The total number of messages matching the criteria specified in the [vx_req_session_archive_query] request. This is the total size of the result set.unsigned int count;
variable next_cursor
A timestamp cursor (ISO format) pointing to the next page of results.char * next_cursor;