vx_evt_session_archive_message
Learn about messaging in Vivox Core.
Read time 2 minutesLast updated 7 months ago
Presented when a message is found in response to a [vx_req_session_archive_query] or [vx_req_session_chat_history_query] request. 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. |
| char * | time_stamp The time stamp of the message in the format specified in XEP-0082. |
| char * | participant_uri The URI of the sender of this message. |
| char * | displayname The displayname, if the participant_uri had a displayname. |
| 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. |
| int | is_current_user Indicates whether the message is from the current logged in user. |
| char * | language The language (default NULL, implies "en"). |
Detailed Description
struct vx_evt_session_archive_message;
Presented when a message is found in response to a [vx_req_session_archive_query] or [vx_req_session_chat_history_query] request.
This event is triggered for every message that is found.
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.
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 or vx_resp_session_chat_history_query response.
variable time_stamp
char * time_stamp;
The time stamp of the message in the format specified in XEP-0082.
variable participant_uri
char * participant_uri;
The URI of the sender of this message.
variable displayname
char * displayname;
The displayname, if the participant_uri had a displayname.
variable message_body
char * message_body;
The content of the message, UTF-8 encoded.
variable message_id
char * message_id;
The server-assigned ID of the message used for paging through large result sets.
variable encoded_uri_with_tag
char * 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).
variable is_current_user
int is_current_user;
Indicates whether the message is from the current logged in user.
variable language
char * language;
The language (default NULL, implies "en").