vx_evt_participant_added
Reference the Vivox Core SDK API.
Read time 3 minutesLast updated 8 months ago
Presented when a participant is added to a session. More...
#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. |
| char * | display_name |
| int | participant_type |
| char * | application |
| int | is_anonymous_login Indicates whether the user is an authenticated user (0) or is logged in anonymously as a guest (1). |
| char * | displayname The display name of the participant if in a channel or a P2P-initiated 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. |
Detailed Description
struct vx_evt_participant_added;
Presented when a participant is added to a session.
When joining a channel, a participant added event is raised for all active participants in the channel.
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 display_name
char * display_name;
Deprecated:
Use displayname instead.
variable participant_type
int participant_type;
Deprecated:
This is deprecated and should not be used.
variable application
char * application;
Deprecated:
This is deprecated and should not be used.
variable is_anonymous_login
int is_anonymous_login;
Indicates whether the user is an authenticated user (0) or is logged in anonymously as a guest (1).
Note: This is only supported on channel calls.
variable displayname
char * displayname;
The display name of the participant if in a channel or a P2P-initiated session.
Note: This field is not populated for the callee in a text-initiated P2P session. This field will contain one of the following values (in order), based on availability:
-
- The buddy display name
-
- The SIP display name (only available for the callee, not available for the caller)
-
- The account name (not available if the account is out of domain)
-
- The URI without the SIP (ex: username@foo.vivox.com)
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 remote user.
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.