vx_req_account_archive_query

Reference the Vivox Core SDK API.

Read time 3 minutes

Last updated 7 months ago

Query messages that were archived by the server for the specified account. More...

#include <VxcRequests.h>

Public Attributes

	Name
vx_req_base_t	base The common properties for all requests.
VX_HANDLE	account_handle The handle returned from a successful login 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 *	channel_uri The fully specified URI of the channel.
char *	participant_uri The fully specified URI of the participant.
char *	display_name The display name 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.
char *	application_stanza_namespace
char *	application_stanza_body

Detailed Description


struct vx_req_account_archive_query;

Query messages that were archived by the server for the specified account.

See: vx_req_session_archive_query

This includes all messages that are sent and received by this account, including directed messages and channel messages. Messages can appear in the archive with a delay of up to several seconds after being sent or received. To query a specific channel's history, use vx_req_session_archive_query.

Public Attributes Documentation

variable base


vx_req_base_t base;

The common properties for all requests.

variable account_handle


VX_HANDLE account_handle;

The handle returned from a successful login request.

variable time_start


char * 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.

variable time_end


char * 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.

variable cursor


char * 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.

variable search_text


char * 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.

variable channel_uri


char * channel_uri;

The fully specified URI of the channel.

Note: This is mutually exclusive with participant_uri.

Only messages to or from the specified channel are returned. This is optional. The default setting is NULL.

variable participant_uri


char * participant_uri;

The fully specified URI of the participant.

Note: This is mutually exclusive with channel_uri.

Only messages to or from the specified participant are returned. This is optional. The default setting is NULL.

variable display_name


char * display_name;

The display name of the participant.

The default setting is NULL.

variable max


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

variable before_id


char * 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.

variable after_id


char * 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.

variable first_message_index


int first_message_index;

The index of the first message to retrieve.

This is optional. The default setting is -1, which indicates to not use this parameter. The first message in the result set always has an index of 0.

variable application_stanza_namespace


char * application_stanza_namespace;

Deprecated:

This is deprecated and should not be used. The namespace of the custom application stanza.

variable application_stanza_body


char * application_stanza_body;