Struct UpdateParticipantParams

pub struct UpdateParticipantParams {

    pub account_sid: String,
    pub conference_sid: String,
    pub call_sid: String,
    pub muted: Option<bool>,
    pub hold: Option<bool>,
    pub hold_url: Option<String>,
    pub hold_method: Option<String>,
    pub announce_url: Option<String>,
    pub announce_method: Option<String>,
    pub wait_url: Option<String>,
    pub wait_method: Option<String>,
    pub beep_on_exit: Option<bool>,
    pub end_conference_on_exit: Option<bool>,
    pub coaching: Option<bool>,
    pub call_sid_to_coach: Option<String>,
}

struct for passing parameters to the method update_participant

Fields

account_sid: String

The SID of the Account that created the Participant resources to update.

conference_sid: String

The SID of the conference with the participant to update.

call_sid: String

The Call SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.

muted: Option<bool>

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.

hold: Option<bool>

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.

hold_url: Option<String>

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 <Play>, <Say>, <Pause>, or <Redirect> verbs.

hold_method: Option<String>

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

announce_url: Option<String>

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

announce_method: Option<String>

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

wait_url: Option<String>

The URL we call using the wait_method for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>, <Say>, <Pause>, or <Redirect> verbs. The default value is the URL of our standard hold music. Learn more about hold music.

wait_method: Option<String>

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.

beep_on_exit: Option<bool>

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

end_conference_on_exit: Option<bool>

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

coaching: Option<bool>

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.

call_sid_to_coach: Option<String>

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.

Trait Implementations

impl Clone for UpdateParticipantParams

fn clone(&self) -> UpdateParticipantParams

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateParticipantParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.