vx_evt_participant_removed

Reference the Vivox Core SDK API.

Read time 2 minutes

Last updated 8 months ago

Module: Group Voice and Text Communications

Presented when a participant is removed from a session.

#include <VxcEvents.h>

Public Attributes

	Name
vx_evt_base_t	base The common properties for all events.
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 create request.
char *	participant_uri The URI of the participant whose state has changed.
char *	account_name The account name of the participant.
vx_participant_removed_reason	reason The reason why the participant was removed from the session.
char *	alias_username The identity of the user if P2P, or null if a channel call.
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.

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 returned from a successful session group create request.

variable session_handle


VX_HANDLE session_handle;

The handle returned from a successful session create request.

variable participant_uri


char * participant_uri;

The URI of the participant whose state has changed.

variable account_name


char * account_name;

The account name of the participant.

variable reason


vx_participant_removed_reason reason;

The reason why the participant was removed from the session.

The default is "left". See vx_participant_removed_reason

variable alias_username


char * alias_username;

The identity of the user if P2P, or null if a channel call.

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.

Documentation

Development

User Acquisition

Monetization

Industry