Documentation

Support

Vivox Core SDK

Vivox Core SDK

vx_evt_user_to_user_message

Learn about messaging in Vivox Core.
Read time 1 minuteLast updated 20 hours ago

Raised when a message from another user is received. More...
#include <VxcEvents.h>

Public Attributes

Name

vx_evt_base_tbase
The common properties for all events.
VX_HANDLEaccount_handle
The handle returned from a successful account login request.
char *from_uri
The URI of the account sending the message.
char *encoded_uri_with_tag
The encoded URI for the sending user with the tag.
char *message_body
The content of the message being received, UTF-8 encoded.
char *message_id
The id of the message.
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).
char *from_displayname
The displayname, if the from_uri had a displayname.

Detailed Description

struct vx_evt_user_to_user_message;
Raised when a message from another user is received. See: vx_req_account_send_message Note: V5 only.

Public Attributes Documentation

variable base

vx_evt_base_t base;
The common properties for all events.

variable account_handle

VX_HANDLE account_handle;
The handle returned from a successful account login request. See: vx_req_account_anonymous_login

variable from_uri

char * from_uri;
The URI of the account sending the message.

variable encoded_uri_with_tag

char * encoded_uri_with_tag;
The encoded URI for the sending user with the tag. This uniquely identifies users that might be logged in with the same account name from multiple devices (Multi-Login).

variable message_body

char * message_body;
The content of the message being received, UTF-8 encoded.

variable message_id

char * message_id;
The id of the message. It is empty unless chat history is enabled.

variable language

char * language;
The language (default NULL, implies "en").

variable application_stanza_namespace

char * application_stanza_namespace;
The namespace of the custom application stanza (optional, default NULL).

variable application_stanza_body

char * application_stanza_body;
The custom application stanza body (optional, default NULL).

variable from_displayname

char * from_displayname;
The displayname, if the from_uri had a displayname.