Class: Telnyx::Models::ConferenceParticipant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/conference_participant.rb

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: nil, call_control_id: nil, call_leg_id: nil, conference_id: nil, created_at: nil, end_conference_on_exit: nil, label: nil, muted: nil, on_hold: nil, soft_end_conference_on_exit: nil, status: nil, updated_at: nil, whisper_call_control_ids: nil) ⇒ Object

Parameters:

  • id (String) (defaults to: nil) —

    Uniquely identifies the participant.

  • call_control_id (String) (defaults to: nil) —

    Unique identifier and token for controlling the participant’s call leg.

  • call_leg_id (String) (defaults to: nil) —

    Unique identifier for the call leg.

  • conference_id (String) (defaults to: nil) —

    Unique identifier for the conference.

  • created_at (Time) (defaults to: nil) —

    Timestamp when the participant joined.

  • end_conference_on_exit (Boolean) (defaults to: nil) —

    Whether the conference ends when this participant exits.

  • label (String) (defaults to: nil) —

    Label assigned to the participant when joining.

  • muted (Boolean) (defaults to: nil) —

    Whether the participant is muted.

  • on_hold (Boolean) (defaults to: nil) —

    Whether the participant is on hold.

  • soft_end_conference_on_exit (Boolean) (defaults to: nil) —

    Whether the conference soft-ends when this participant exits.

  • status (Symbol, Telnyx::Models::ConferenceParticipant::Status) (defaults to: nil) —

    Status of the participant.

  • updated_at (Time) (defaults to: nil) —

    Timestamp when the participant was last updated.

  • whisper_call_control_ids (Array<String>) (defaults to: nil) —

    List of call control IDs this participant is whispering to.




# File 'lib/telnyx/models/conference_participant.rb', line 84

Instance Attribute Details

#call_control_id ⇒ String?

Unique identifier and token for controlling the participant’s call leg.

Returns:

  • (String, nil) 


16
 
# File 'lib/telnyx/models/conference_participant.rb', line 16

optional :call_control_id, String

#call_leg_id ⇒ String?

Unique identifier for the call leg.

Returns:

  • (String, nil) 


22
 
# File 'lib/telnyx/models/conference_participant.rb', line 22

optional :call_leg_id, String

#conference_id ⇒ String?

Unique identifier for the conference.

Returns:

  • (String, nil) 


28
 
# File 'lib/telnyx/models/conference_participant.rb', line 28

optional :conference_id, String

#created_at ⇒ Time?

Timestamp when the participant joined.

Returns:

  • (Time, nil) 


34
 
# File 'lib/telnyx/models/conference_participant.rb', line 34

optional :created_at, Time

#end_conference_on_exit ⇒ Boolean?

Whether the conference ends when this participant exits.

Returns:

  • (Boolean, nil) 


40
 
# File 'lib/telnyx/models/conference_participant.rb', line 40

optional :end_conference_on_exit, Telnyx::Internal::Type::Boolean

#id ⇒ String?

Uniquely identifies the participant.

Returns:

  • (String, nil) 


10
 
# File 'lib/telnyx/models/conference_participant.rb', line 10

optional :id, String

#label ⇒ String?

Label assigned to the participant when joining.

Returns:

  • (String, nil) 


46
 
# File 'lib/telnyx/models/conference_participant.rb', line 46

optional :label, String

#muted ⇒ Boolean?

Whether the participant is muted.

Returns:

  • (Boolean, nil) 


52
 
# File 'lib/telnyx/models/conference_participant.rb', line 52

optional :muted, Telnyx::Internal::Type::Boolean

#on_hold ⇒ Boolean?

Whether the participant is on hold.

Returns:

  • (Boolean, nil) 


58
 
# File 'lib/telnyx/models/conference_participant.rb', line 58

optional :on_hold, Telnyx::Internal::Type::Boolean

#soft_end_conference_on_exit ⇒ Boolean?

Whether the conference soft-ends when this participant exits.

Returns:

  • (Boolean, nil) 


64
 
# File 'lib/telnyx/models/conference_participant.rb', line 64

optional :soft_end_conference_on_exit, Telnyx::Internal::Type::Boolean

#status ⇒ Symbol, ...

Status of the participant.

Returns:



70
 
# File 'lib/telnyx/models/conference_participant.rb', line 70

optional :status, enum: -> { Telnyx::ConferenceParticipant::Status }

#updated_at ⇒ Time?

Timestamp when the participant was last updated.

Returns:

  • (Time, nil) 


76
 
# File 'lib/telnyx/models/conference_participant.rb', line 76

optional :updated_at, Time

#whisper_call_control_ids ⇒ Array<String>?

List of call control IDs this participant is whispering to.

Returns:

  • (Array<String>, nil) 


82
 
# File 'lib/telnyx/models/conference_participant.rb', line 82

optional :whisper_call_control_ids, Telnyx::Internal::Type::ArrayOf[String]