vx_evt_message
Learn about messaging in Vivox Core.
Read time 2 minutesLast updated 20 hours ago
Module: Group Voice and Text Communications Presented when an incoming message has arrived from a participant in an open session with text enabled.
#include <VxcEvents.h>Public Attributes
Name | |
|---|---|
| vx_evt_base_t | base The common properties for all events. |
| vx_message_state | state |
| VX_HANDLE | sessiongroup_handle The handle returned from a successful session group create request. |
| VX_HANDLE | session_handle The handle returned from a successful session add request. |
| char * | participant_uri The URI of the sender of the message. |
| char * | message_header The content type of the message. |
| char * | message_body The contents of the message. |
| char * | message_id The id of the message. |
| char * | participant_displayname The displayname, if the participant_uri had a displayname. |
| char * | application The application of the entity who is sending the message. |
| char * | alias_username The identity that the original sender wanted to present. |
| char * | encoded_uri_with_tag The encoded URI for the 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"). |
| char * | application_stanza_namespace The namespace of the custom application stanza (optional, default NULL). |
| char * | application_stanza_body The custom application stanza body (optional, default NULL). |
Public Attributes Documentation
variable base
The common properties for all events.vx_evt_base_t base;
variable state
Deprecated: This is deprecated and should not be used.vx_message_state state;
variable sessiongroup_handle
The handle returned from a successful session group create request. See: vx_req_sessiongroup_createVX_HANDLE sessiongroup_handle;
variable session_handle
The handle returned from a successful session add request. See: vx_req_sessiongroup_add_sessionVX_HANDLE session_handle;
variable participant_uri
The URI of the sender of the message.char * participant_uri;
variable message_header
The content type of the message.char * message_header;
variable message_body
The contents of the message.char * message_body;
variable message_id
The id of the message. It is empty unless chat history is enabled.char * message_id;
variable participant_displayname
The displayname, if the participant_uri had a displayname.char * participant_displayname;
variable application
The application of the entity who is sending the message. This can be NULL or empty.char * application;
variable alias_username
The identity that the original sender wanted to present. Note: This is different than the participant_uri, which is the actual internal Vivox identity of the original sender.char * alias_username;
variable encoded_uri_with_tag
The encoded URI for the user with the tag. This uniquely identifies users that might appear multiple times in a channel.char * encoded_uri_with_tag;
variable is_current_user
Indicates whether the message is from the current logged in user.int is_current_user;
variable language
The language (default NULL, implies "en"). Note: V5 only. In V4, this is always NULL.char * language;
variable application_stanza_namespace
The namespace of the custom application stanza (optional, default NULL). Note: V5 only. In V4, this is always NULL.char * application_stanza_namespace;
variable application_stanza_body
The custom application stanza body (optional, default NULL). Note: V5 only. In V4, this is always NULL.char * application_stanza_body;