vx_evt_message#

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#

Public Attributes Documentation#

variable base#

vx_evt_base_t base;

The common properties for all events.

variable state#

vx_message_state state;

Deprecated:

This is deprecated and should not be used.

variable sessiongroup_handle#

VX_HANDLE sessiongroup_handle;

The handle returned from a successful session group create request.

See: vx_req_sessiongroup_create

variable session_handle#

VX_HANDLE session_handle;

The handle returned from a successful session add request.

See: vx_req_sessiongroup_add_session

variable participant_uri#

char * participant_uri;

The URI of the sender of the message.

variable message_header#

char * message_header;

The content type of the message.

variable message_body#

char * message_body;

The contents of the message.

variable message_id#

char * message_id;

The id of the message.

It is empty unless chat history is enabled.

variable participant_displayname#

char * participant_displayname;

The displayname, if the participant_uri had a displayname.

variable application#

char * application;

The application of the entity who is sending the message.

This can be NULL or empty.

variable alias_username#

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

variable encoded_uri_with_tag#

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

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").

Note: V5 only. In V4, this is always NULL.

variable application_stanza_namespace#

char * application_stanza_namespace;

The namespace of the custom application stanza (optional, default NULL).

Note: V5 only. In V4, this is always NULL.

variable application_stanza_body#

char * application_stanza_body;

The custom application stanza body (optional, default NULL).

Note: V5 only. In V4, this is always NULL.