vx_evt_session_archive_query_end

Reference the Vivox Core SDK API.

Read time 2 minutes

Last updated 8 months 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


struct vx_evt_session_archive_query_end;

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.

Public Attributes Documentation

variable base


vx_evt_base_t base;

The common properties for all events.

variable sessiongroup_handle


VX_HANDLE sessiongroup_handle;

The handle used in vx_req_sessiongroup_addsession.

See: vx_req_sessiongroup_addsession

variable session_handle


VX_HANDLE session_handle;

The handle returned from a successful session add request.

See: vx_req_sessiongroup_add_session

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_session_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_session_archive_message event.

variable count


unsigned int 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.

variable next_cursor


char * next_cursor;

A timestamp cursor (ISO format) pointing to the next page of results.

Documentation

Development

User Acquisition

Monetization

Industry