conference participant

This controls how a conference participant interacts with a conference.

It contains the following properties:

Property	Required/Optional	Default	Description
talker	optional	true	true or false. Whether this participant can talk to the conference.
start on entry	optional	true	true or false. Whether the conference should start when this participant enters.
destroy on exit	optional	false	true or false. Whether the conference should be destroyed when this participant exits.
beep on entry	optional	true	true or false. Whether a beep should be played to the conference when this participant enters.
exit digit	optional	-	A string containing a single digit that results in the participant leaving the conference. `null` or an empty string signifies no exit digit. Valid digits are 0123456789ABCD#*.
mute digit	optional	-	A string containing a single digit that will mute the participant's audio input if pressed. If no unmute digit is specified, this will toggle mute on and off. `null` or an empty string signifies no mute digit. Valid digits are 0123456789ABCD#*.
unmute digit	optional	mute digit	A string containing a single digit that will unmute the participant's audio input if pressed. `null` or an empty string results in the `mute digit` toggling mute on and off. Valid digits are 0123456789ABCD#*.
while stopped media	optional	-	A play action to play in an endless loop while the conference is stopped.
name	optional	-	A play action to play the participant's name.
has joined message	optional	-	A play action to play when the participant has joined.
has left message	optional	-	A play action to play when the participant has left.

JSON
C#
VB
Java
Python
PHP

Examples:

Example 1

Configure some features for a conference participant:

    {
		"talker" : true,
		"beep_on_entry" : true,
		"mute_digit" : "#",
		"has_joined_message" :
		{
			"play" :
			{
				"play_list" :
				[
					{
						"text_to_say" : "someone has joined the conference"
					}
				]
			}
		}
	}

ConferenceParticipant Class
Namespace: Aculab.Cloud.RestAPIWrapper
Assembly: Aculab.Cloud.RestAPIWrapper.dll

A class that represents a participant in a telephony conference. It provides parameters that control how the participant interacts with the conference.

public class ConferenceParticipant 
{
    // Members
    public bool? Talker;
    public bool? StartOnEntry;
    public bool? DestroyOnExit;
    public bool? BeepOnEntry;
    public char? ExitDigit;
    public char? MuteDigit;
    public char? UnmuteDigit;
    public Play WhileStoppedMedia;
    public Play Name;
    public Play HasJoinedMessage;
    public Play HasLeftMessage;
}

Examples:

Example 1

Configure some features for a conference participant:

var participant = new ConferenceParticipant()
{
    Talker = true,
    BeepOnEntry = true,
    MuteDigit = '#',
    HasJoinedMessage = Play.SayText("someone has joined the conference")
};

public class ConferenceParticipant 
{
    // Members
    public bool? Talker;
    public bool? StartOnEntry;
    public bool? DestroyOnExit;
    public bool? BeepOnEntry;
    public char? ExitDigit;
    public char? MuteDigit;
    public char? UnmuteDigit;
    public Play WhileStoppedMedia;
    public Play Name;
    public Play HasJoinedMessage;
    public Play HasLeftMessage;
}

Examples:

Example 1

Configure some features for a conference participant:

var participant = new ConferenceParticipant()
{
    Talker = true,
    BeepOnEntry = true,
    MuteDigit = '#',
    HasJoinedMessage = Play.SayText("someone has joined the conference")
};

public class ConferenceParticipant 
{
    // Members
    public bool? Talker;
    public bool? StartOnEntry;
    public bool? DestroyOnExit;
    public bool? BeepOnEntry;
    public char? ExitDigit;
    public char? MuteDigit;
    public char? UnmuteDigit;
    public Play WhileStoppedMedia;
    public Play Name;
    public Play HasJoinedMessage;
    public Play HasLeftMessage;
}

Examples:

Example 1

Configure some features for a conference participant:

var participant = new ConferenceParticipant()
{
    Talker = true,
    BeepOnEntry = true,
    MuteDigit = '#',
    HasJoinedMessage = Play.SayText("someone has joined the conference")
};

ConferenceParticipant Class
Namespace: Aculab.Cloud.RestAPIWrapper
Assembly: Aculab.Cloud.RestAPIWrapper.dll

A class that represents a participant in a telephony conference. It provides parameters that control how the participant interacts with the conference.

.Net Framework
.Net Standard

Public Class ConferenceParticipant
    ' Members
    Public Property Talker As Bool?
    Public Property StartOnEntry As Bool?
    Public Property DestroyOnExit As Bool?
    Public Property BeepOnEntry As Bool?
    Public Property ExitDigit As Char?
    Public Property MuteDigit As Char?
    Public Property UnmuteDigit As Char?
    Public Property WhileStoppedMedia As Play
    Public Property Name As Play
    Public Property HasJoinedMessage As Play
    Public Property HasLeftMessage As Play
End Class

Examples:

Example 1

Configure some features for a conference participant:

Dim participant = New ConferenceParticipant()
participant.Talker = True
participant.BeepOnEntry = True
participant.MuteDigit = "#"
participant.HasJoinedMessage = Play.SayText("someone has joined the conference")

Public Class ConferenceParticipant
    ' Members
    Public Property Talker As Bool?
    Public Property StartOnEntry As Bool?
    Public Property DestroyOnExit As Bool?
    Public Property BeepOnEntry As Bool?
    Public Property ExitDigit As Char?
    Public Property MuteDigit As Char?
    Public Property UnmuteDigit As Char?
    Public Property WhileStoppedMedia As Play
    Public Property Name As Play
    Public Property HasJoinedMessage As Play
    Public Property HasLeftMessage As Play
End Class

Examples:

Example 1

Configure some features for a conference participant:

Dim participant = New ConferenceParticipant()
participant.Talker = True
participant.BeepOnEntry = True
participant.MuteDigit = "#"
participant.HasJoinedMessage = Play.SayText("someone has joined the conference")

class ConferenceParticipant extends JSONElement

Represents the conference participant support class.

Class synopsis:

// Constructors:
public ConferenceParticipant()

// Members:
public void setTalker(boolean talker)
public void setStartOnEntry(boolean start)
public void setDestroyOnExit(boolean destroy)
public void setBeepOnEntry(boolean beep)
public void setExitDigit(char exitDigit)
public void setMuteDigit(char muteDigit)
public void setUnmuteDigit(char unmuteDigit)
public void setWhileStoppedMedia(Play media)
public void setName(Play name)
public void setHasJoinedMessage(Play message)
public void setHasLeftMessage(Play message)

Examples:

Example 1

Configure some features for a conference participant:

ConferenceParticipant confParticipant = new ConferenceParticipant();
confParticipant.setTalker(true);
confParticipant.setBeepOnEntry(true);
confParticipant.setMuteDigit('#');
confParticipant.setHasJoinedMessage(Play.sayText("someone has joined the conference"));

class ConferenceParticipant

Represents the conference participant support class.

Class synopsis:

# ConferenceParticipant object:
ConferenceParticipant(talker=None,
                      start_on_entry=None,
                      destroy_on_exit=None,
                      beep_on_entry=None,
                      mute_digit=None,
                      unmute_digit=None,
                      exit_digit=None,
                      while_stopped_media=None,
                      name=None,
                      has_joined_message=None,
                      has_left_message=None)

Examples:

Example 1

Configure some features for a conference participant:

conference_participant = ConferenceParticipant(talker=True, 
                                               beep_on_entry=True, 
                                               mute_digit='#', 
                                               has_joined_message=Play(text_to_say='someone has joined the conference'))

The ConferenceParticipantConfiguration class

Introduction

Represents the conference participant configuration.

Class synopsis

class ConferenceParticipantConfiguration {

    /* methods */
    public __construct($opts = null)
    public self setTalker(boolean $talker)
    public self setStartOnEntry(boolean $start)
    public self setDestroyOnExit(boolean $stop)
    public self setBeepOnEntry(boolean $beep)
    public self setExitDigit(string $digit)
    public self setMuteDigit(string $digit)
    public self setUnmuteDigit(string $digit)
    public self setWhileStoppedMedia(Play $play)
    public self setHasJoinedMessage(Play $play)
    public self setHasLeftMessage(Play $play)
    public self setName(Play $play)
}

Examples:

Example 1

Configure some features for a conference participant:

$participant_config = new \Aculab\TelephonyRestAPI\ConferenceParticipantConfiguration();
$participant_config->setTalker(true)
    ->setBeepOnEntry(true)
    ->setMuteDigit('#')
    ->setHasJoinedMessage(\Aculab\TelephonyRestAPI\Play::sayText('someone has joined the conference'));