Package com.twilio.rest.api.v2010.account.conference

Class ParticipantUpdater

java.lang.Object

com.twilio.base.Updater<Participant>

com.twilio.rest.api.v2010.account.conference.ParticipantUpdater

public class ParticipantUpdater
extends Updater<Participant>

Constructor Summary

Constructors

Constructor	Description
ParticipantUpdater(String pathConferenceSid, String pathCallSid)	Construct a new ParticipantUpdater.
ParticipantUpdater(String pathAccountSid, String pathConferenceSid, String pathCallSid)	Construct a new ParticipantUpdater.

Method Summary

Modifier and Type	Method	Description
ParticipantUpdater	setAnnounceMethod(HttpMethod announceMethod)	The HTTP method we should use to call `announce_url`.
ParticipantUpdater	setAnnounceUrl(String announceUrl)	The URL we call using the `announce_method` for an announcement to the participant.
ParticipantUpdater	setAnnounceUrl(URI announceUrl)	The URL we call using the `announce_method` for an announcement to the participant.
ParticipantUpdater	setBeepOnExit(Boolean beepOnExit)	Whether to play a notification beep to the conference when the participant exits.
ParticipantUpdater	setCallSidToCoach(String callSidToCoach)	The SID of the participant who is being `coached`.
ParticipantUpdater	setCoaching(Boolean coaching)	Whether the participant is coaching another call.
ParticipantUpdater	setEndConferenceOnExit(Boolean endConferenceOnExit)	Whether to end the conference when the participant leaves.
ParticipantUpdater	setHold(Boolean hold)	Whether the participant should be on hold.
ParticipantUpdater	setHoldMethod(HttpMethod holdMethod)	The HTTP method we should use to call `hold_url`.
ParticipantUpdater	setHoldUrl(String holdUrl)	The URL we call using the `hold_method` for music that plays when the participant is on hold.
ParticipantUpdater	setHoldUrl(URI holdUrl)	The URL we call using the `hold_method` for music that plays when the participant is on hold.
ParticipantUpdater	setMuted(Boolean muted)	Whether the participant should be muted.
ParticipantUpdater	setWaitMethod(HttpMethod waitMethod)	The HTTP method we should use to call `wait_url`.
ParticipantUpdater	setWaitUrl(String waitUrl)	The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start.
ParticipantUpdater	setWaitUrl(URI waitUrl)	The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start.
Participant	update(TwilioRestClient client)	Make the request to the Twilio API to perform the update.

Methods inherited from class com.twilio.base.Updater

update, updateAsync, updateAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParticipantUpdater

public ParticipantUpdater(String pathConferenceSid,
                          String pathCallSid)

Construct a new ParticipantUpdater.

Parameters:

pathConferenceSid - The SID of the conference with the participant to update

pathCallSid - The Call SID of the resources to update

ParticipantUpdater

public ParticipantUpdater(String pathAccountSid,
                          String pathConferenceSid,
                          String pathCallSid)

Construct a new ParticipantUpdater.

Parameters:

pathAccountSid - The SID of the Account that created the resources to update

pathConferenceSid - The SID of the conference with the participant to update

pathCallSid - The Call SID of the resources to update

Method Detail

setMuted

public ParticipantUpdater setMuted(Boolean muted)

Whether the participant should be muted. Can be `true` or `false. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`..

Parameters:

muted - Whether the participant should be muted

Returns:

this

setHold

public ParticipantUpdater setHold(Boolean hold)

Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference..

Parameters:

hold - Whether the participant should be on hold

Returns:

this

setHoldUrl

public ParticipantUpdater setHoldUrl(URI holdUrl)

The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains the `<Play>`, `<Say>` or `<Redirect>` commands..

Parameters:

holdUrl - The URL we call using the `hold_method` for music that plays when the participant is on hold

Returns:

this

setHoldUrl

public ParticipantUpdater setHoldUrl(String holdUrl)

The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains the `<Play>`, `<Say>` or `<Redirect>` commands..

Parameters:

holdUrl - The URL we call using the `hold_method` for music that plays when the participant is on hold

Returns:

this

setHoldMethod

public ParticipantUpdater setHoldMethod(HttpMethod holdMethod)

The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`..

Parameters:

holdMethod - The HTTP method we should use to call hold_url

Returns:

this

setAnnounceUrl

public ParticipantUpdater setAnnounceUrl(URI announceUrl)

The URL we call using the `announce_method` for an announcement to the participant. The URL must return an MP3 file, a WAV file, or a TwiML document that contains `<Play>` or `<Say>` commands..

Parameters:

announceUrl - The URL we call using the `announce_method` for an announcement to the participant

Returns:

this

setAnnounceUrl

public ParticipantUpdater setAnnounceUrl(String announceUrl)

The URL we call using the `announce_method` for an announcement to the participant. The URL must return an MP3 file, a WAV file, or a TwiML document that contains `<Play>` or `<Say>` commands..

Parameters:

announceUrl - The URL we call using the `announce_method` for an announcement to the participant

Returns:

this

setAnnounceMethod

public ParticipantUpdater setAnnounceMethod(HttpMethod announceMethod)

The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`..

Parameters:

announceMethod - The HTTP method we should use to call announce_url

Returns:

this

setWaitUrl

public ParticipantUpdater setWaitUrl(URI waitUrl)

The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic)..

Parameters:

waitUrl - URL that hosts pre-conference hold music

Returns:

this

setWaitUrl

public ParticipantUpdater setWaitUrl(String waitUrl)

The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic)..

Parameters:

waitUrl - URL that hosts pre-conference hold music

Returns:

this

setWaitMethod

public ParticipantUpdater setWaitMethod(HttpMethod waitMethod)

The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file..

Parameters:

waitMethod - The HTTP method we should use to call `wait_url`

Returns:

this

setBeepOnExit

public ParticipantUpdater setBeepOnExit(Boolean beepOnExit)

Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`..

Parameters:

beepOnExit - Whether to play a notification beep to the conference when the participant exit

Returns:

this

setEndConferenceOnExit

public ParticipantUpdater setEndConferenceOnExit(Boolean endConferenceOnExit)

Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`..

Parameters:

endConferenceOnExit - Whether to end the conference when the participant leaves

Returns:

this

setCoaching

public ParticipantUpdater setCoaching(Boolean coaching)

Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined..

Parameters:

coaching - Indicates if the participant changed to coach

Returns:

this

setCallSidToCoach

public ParticipantUpdater setCallSidToCoach(String callSidToCoach)

The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`..

Parameters:

callSidToCoach - The SID of the participant who is being `coached`

Returns:

this

update

public Participant update(TwilioRestClient client)

Make the request to the Twilio API to perform the update.

Specified by:

update in class Updater<Participant>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Updated Participant