Struct SipConfig 

#[non_exhaustive]
pub struct SipConfig {
    pub create_conversation_on_the_fly: bool,
    pub inactive_start: bool,
    pub max_audio_recording_duration: Option<Duration>,
    pub allow_virtual_agent_interaction: bool,
    pub keep_conversation_running: bool,
    pub copy_inbound_call_leg_headers: Vec<String>,
    pub ignore_reinvite_media_direction: bool,
    /* private fields */
}

Available on crate features conversation-profiles or conversations only.

Defines the SIP configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

create_conversation_on_the_fly: bool

Asks Dialogflow Telephony to create the conversation provided in the SIP header on the fly when the call comes in.

inactive_start: bool

Starts the conversation with inactive SDP directives

max_audio_recording_duration: Option<Duration>

Max duration for audio recording. Overrides the default value of 15 min. Max value is 8 hours.

allow_virtual_agent_interaction: bool

Allows interactions with a Dialogflow virtual agent even if the call is connected for SIPREC purposes.

keep_conversation_running: bool

Keeps the conversation running even if the call is disconnected.

copy_inbound_call_leg_headers: Vec<String>

List of inbound call leg headers to be copied to outbound call legs created later.

ignore_reinvite_media_direction: bool

Ignores any media direction in the reINVITE SDP offer. Reuse the previous media direction.

Implementations

impl SipConfig

pub fn new() -> Self

Creates a new default instance.

pub fn set_create_conversation_on_the_fly<T: Into<bool>>(self, v: T) -> Self

Sets the value of create_conversation_on_the_fly.

Example

let x = SipConfig::new().set_create_conversation_on_the_fly(true);

pub fn set_inactive_start<T: Into<bool>>(self, v: T) -> Self

Sets the value of inactive_start.

Example

let x = SipConfig::new().set_inactive_start(true);

pub fn set_max_audio_recording_duration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of max_audio_recording_duration.

Example

use wkt::Duration;
let x = SipConfig::new().set_max_audio_recording_duration(Duration::default()/* use setters */);

pub fn set_or_clear_max_audio_recording_duration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of max_audio_recording_duration.

Example

use wkt::Duration;
let x = SipConfig::new().set_or_clear_max_audio_recording_duration(Some(Duration::default()/* use setters */));
let x = SipConfig::new().set_or_clear_max_audio_recording_duration(None::<Duration>);

pub fn set_allow_virtual_agent_interaction<T: Into<bool>>(self, v: T) -> Self

Sets the value of allow_virtual_agent_interaction.

Example

let x = SipConfig::new().set_allow_virtual_agent_interaction(true);

pub fn set_keep_conversation_running<T: Into<bool>>(self, v: T) -> Self

Sets the value of keep_conversation_running.

Example

let x = SipConfig::new().set_keep_conversation_running(true);

pub fn set_copy_inbound_call_leg_headers<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of copy_inbound_call_leg_headers.

Example

let x = SipConfig::new().set_copy_inbound_call_leg_headers(["a", "b", "c"]);

pub fn set_ignore_reinvite_media_direction<T: Into<bool>>(self, v: T) -> Self

Sets the value of ignore_reinvite_media_direction.

Example

let x = SipConfig::new().set_ignore_reinvite_media_direction(true);

Trait Implementations

impl Clone for SipConfig

fn clone(&self) -> SipConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SipConfig

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

Formats the value using the given formatter.

impl Default for SipConfig

fn default() -> SipConfig

Returns the “default value” for a type.

impl Message for SipConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SipConfig

fn eq(&self, other: &SipConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SipConfig