vx_req_session_archive_query
Reference the Vivox Core SDK API.
Read time 3 minutesLast updated a day ago
Module: Group Voice and Text Communications Query messages that were archived by the server for the specified channel. More...
#include <VxcRequests.h>Public Attributes
Name | |
|---|---|
| vx_req_base_t | base The common properties for all requests. |
| VX_HANDLE | session_handle The handle returned from a successful [vx_req_sessiongroup_add_session] request. |
| char * | time_start Exclude all messages before a specified date or time from the query results. |
| char * | time_end Exclude all messages after a specified date or time from the query results. |
| char * | cursor When requesting the first page of results, this value can remain nullptr or empty. |
| char * | search_text The text to find in the query. |
| char * | participant_uri The fully specified URI of the participant. |
| unsigned int | max The maximum number of messages to find in the query. |
| char * | before_id The message_id for paging backward through large query result sets. |
| char * | after_id The message_id for paging forward through large query result sets. |
| int | first_message_index The index of the first message to retrieve from the query. |
| char * | display_name A readable name for display only. |
| char * | application_stanza_namespace |
| char * | application_stanza_body |
Detailed Description
Query messages that were archived by the server for the specified channel. See: vx_resp_session_archive_query This includes all messages that are sent and received by using vx_req_session_send_message. This does not include any message that is sent or received by using vx_req_account_send_message. Messages can appear in the archive with a delay of up to several seconds after being sent or received. To query P2P message history, use vx_req_account_archive_query.struct vx_req_session_archive_query;
Public Attributes Documentation
variable base
The common properties for all requests.vx_req_base_t base;
variable session_handle
The handle returned from a successful [vx_req_sessiongroup_add_session] request.VX_HANDLE session_handle;
variable time_start
Exclude all messages before a specified date or time from the query results. Specify the start time by using a format defined in XEP-0082. This is optional. The default setting is NULL.char * time_start;
variable time_end
Exclude all messages after a specified date or time from the query results. Specify the end time by using a format defined in XEP-0082. This is optional. The default setting is NULL.char * time_end;
variable cursor
When requesting the first page of results, this value can remain nullptr or empty. Responses provide a next_cursor value pointing to the next page of results when the result size is greater than the page size. Set the cursor value with the next_cursor from previous responses when applicable.char * cursor;
variable search_text
The text to find in the query. Only messages that contain the specified text are returned. This is optional. The default setting is NULL.char * search_text;
variable participant_uri
The fully specified URI of the participant. Only messages to or from the specified participant are returned. This is optional. The default setting is NULL.char * participant_uri;
variable max
The maximum number of messages to find in the query. This is optional. The default value is 10. Set to 0 to get the total message count without retrieving the messages.unsigned int max;
variable before_id
The message_id for paging backward through large query result sets. Note: This parameter cannot be used simultaneously with parameter after_id. This is optional. The default setting is NULL. The query results include messages that immediately precede the specified message in the result set.char * before_id;
variable after_id
The message_id for paging forward through large query result sets. Note: This parameter cannot be used simultaneously with parameter before_id. This is optional. The default setting is NULL. The query results include messages that immediately follow the specified message in the result set.char * after_id;
variable first_message_index
The index of the first message to retrieve from the query. This is optional. The default value is -1, which indicates to not use this parameter. The first message in the result set always has an index of 0.int first_message_index;
variable display_name
A readable name for display only.char * display_name;
variable application_stanza_namespace
Deprecated: This is deprecated and should not be used. The namespace of the custom application stanza.char * application_stanza_namespace;
variable application_stanza_body
Deprecated: This is deprecated and should not be used. The body of the custom application stanza.char * application_stanza_body;