vx_evt_account_archive_message
Learn about messaging in Vivox Core.
Read time 2 minutesLast updated 20 hours ago
Presented when a message is found in response to [vx_req_account_archive_query] or [vx_req_account_chat_history_query] request. 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. |
| char * | time_stamp The time stamp of the message in the format specified in XEP-0082. |
| char * | channel_uri The URI of the channel that this message was exchanged in. |
| char * | participant_uri The URI of the sender/receiver of the message for inbound/outbound messages, respectively. |
| char * | displayname The displayname of the sender/receiver of the message. |
| int | is_inbound The message direction: 1 for inbound, and 0 for outbound. |
| char * | message_body The content of the message, UTF-8 encoded. |
| char * | message_id The server-assigned ID of the message used for paging through large result sets. |
| char * | encoded_uri_with_tag The encoded URI for the sending user with the tag. |
| char * | language The language (default NULL, implies "en"). |
Detailed Description
Presented when a message is found in response to [vx_req_account_archive_query] or [vx_req_account_chat_history_query] request. This event is triggered for every message found.struct vx_evt_account_archive_message;
Public Attributes Documentation
variable base
The common properties for all events.vx_evt_base_t base;
variable account_handle
The handle returned from a successful account login request. See: vx_req_account_anonymous_loginVX_HANDLE account_handle;
variable 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 or vx_resp_account_chat_history_query response.char * query_id;
variable time_stamp
The time stamp of the message in the format specified in XEP-0082.char * time_stamp;
variable channel_uri
The URI of the channel that this message was exchanged in. Note: Mutually exclusive with participant_uri.char * channel_uri;
variable participant_uri
The URI of the sender/receiver of the message for inbound/outbound messages, respectively. Note: Mutually exclusive with channel_uri.char * participant_uri;
variable displayname
The displayname of the sender/receiver of the message.char * displayname;
variable is_inbound
The message direction: 1 for inbound, and 0 for outbound.int is_inbound;
variable message_body
The content of the message, UTF-8 encoded.char * message_body;
variable message_id
The server-assigned ID of the message used for paging through large result sets.char * message_id;
variable encoded_uri_with_tag
The encoded URI for the sending user with the tag. Note: These users can be joined to a channel from only one device at any given moment of time (no Multi-Join). This uniquely identifies users that might be logged in with the same account name from multiple devices (Multi-Login).char * encoded_uri_with_tag;
variable language
The language (default NULL, implies "en").char * language;