vx_evt_participant_removed
Reference the Vivox Core SDK API.
Read time 1 minuteLast updated a day 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
The common properties for all events.vx_evt_base_t base;
variable sessiongroup_handle
The handle returned from a successful session group create request.VX_HANDLE sessiongroup_handle;
variable session_handle
The handle returned from a successful session create request.VX_HANDLE session_handle;
variable participant_uri
The URI of the participant whose state has changed.char * participant_uri;
variable account_name
The account name of the participant.char * account_name;
variable reason
The reason why the participant was removed from the session. The default is "left". See vx_participant_removed_reasonvx_participant_removed_reason reason;
variable 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.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;