Class: Twilio::REST::Insights::V1::ConferenceInstance
- Inherits:
-
Twilio::REST::InstanceResource
- Object
- Twilio::REST::InstanceResource
- Twilio::REST::Insights::V1::ConferenceInstance
- Defined in:
- lib/twilio-ruby/rest/insights/v1/conference.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique SID identifier of the Account.
-
#conference_participants ⇒ conference_participants
Access the conference_participants.
-
#conference_sid ⇒ String
The unique SID identifier of the Conference.
-
#connect_duration_seconds ⇒ String
Duration of the between conference start event and conference end event in seconds.
-
#context ⇒ ConferenceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#create_time ⇒ Time
Conference creation date and time in ISO 8601 format.
-
#detected_issues ⇒ Hash
Potential issues detected by Twilio during the conference.
-
#duration_seconds ⇒ String
Conference duration in seconds.
- #end_reason ⇒ ConferenceEndReason
-
#end_time ⇒ Time
Conference end date and time in ISO 8601 format.
-
#ended_by ⇒ String
Call SID of the participant whose actions ended the conference.
-
#fetch ⇒ ConferenceInstance
Fetch the ConferenceInstance.
-
#friendly_name ⇒ String
Custom label for the conference resource, up to 64 characters.
-
#initialize(version, payload, conference_sid: nil) ⇒ ConferenceInstance
constructor
Initialize the ConferenceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
Contains a dictionary of URL links to nested resources of this Conference.
-
#max_concurrent_participants ⇒ String
Actual maximum number of concurrent participants in the conference.
-
#max_participants ⇒ String
Maximum number of concurrent participants as specified by the configuration.
- #mixer_region ⇒ Region
- #mixer_region_requested ⇒ Region
- #processing_state ⇒ ProcessingState
-
#recording_enabled ⇒ Boolean
Boolean.
-
#start_time ⇒ Time
Timestamp in ISO 8601 format when the conference started.
- #status ⇒ ConferenceStatus
-
#tag_info ⇒ Hash
Object.
-
#tags ⇒ Array<Tag>
Tags for detected conference conditions and participant behaviors which may be of interest.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_participants ⇒ String
Unique conference participants based on caller ID.
-
#url ⇒ String
The URL of this resource.
Constructor Details
#initialize(version, payload, conference_sid: nil) ⇒ ConferenceInstance
Initialize the ConferenceInstance
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 290 def initialize(version, payload , conference_sid: nil) super(version) # Marshaled Properties @properties = { 'conference_sid' => payload['conference_sid'], 'account_sid' => payload['account_sid'], 'friendly_name' => payload['friendly_name'], 'create_time' => Twilio.deserialize_iso8601_datetime(payload['create_time']), 'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']), 'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']), 'duration_seconds' => payload['duration_seconds'] == nil ? payload['duration_seconds'] : payload['duration_seconds'].to_i, 'connect_duration_seconds' => payload['connect_duration_seconds'] == nil ? payload['connect_duration_seconds'] : payload['connect_duration_seconds'].to_i, 'status' => payload['status'], 'max_participants' => payload['max_participants'] == nil ? payload['max_participants'] : payload['max_participants'].to_i, 'max_concurrent_participants' => payload['max_concurrent_participants'] == nil ? payload['max_concurrent_participants'] : payload['max_concurrent_participants'].to_i, 'unique_participants' => payload['unique_participants'] == nil ? payload['unique_participants'] : payload['unique_participants'].to_i, 'end_reason' => payload['end_reason'], 'ended_by' => payload['ended_by'], 'mixer_region' => payload['mixer_region'], 'mixer_region_requested' => payload['mixer_region_requested'], 'recording_enabled' => payload['recording_enabled'], 'detected_issues' => payload['detected_issues'], 'tags' => payload['tags'], 'tag_info' => payload['tag_info'], 'processing_state' => payload['processing_state'], 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { 'conference_sid' => conference_sid || @properties['conference_sid'] , } end |
Instance Method Details
#account_sid ⇒ String
344 345 346 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 344 def account_sid @properties['account_sid'] end |
#conference_participants ⇒ conference_participants
Access the conference_participants
485 486 487 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 485 def conference_participants context.conference_participants end |
#conference_sid ⇒ String
338 339 340 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 338 def conference_sid @properties['conference_sid'] end |
#connect_duration_seconds ⇒ String
380 381 382 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 380 def connect_duration_seconds @properties['connect_duration_seconds'] end |
#context ⇒ ConferenceContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
329 330 331 332 333 334 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 329 def context unless @instance_context @instance_context = ConferenceContext.new(@version , @params['conference_sid']) end @instance_context end |
#create_time ⇒ Time
356 357 358 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 356 def create_time @properties['create_time'] end |
#detected_issues ⇒ Hash
440 441 442 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 440 def detected_issues @properties['detected_issues'] end |
#duration_seconds ⇒ String
374 375 376 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 374 def duration_seconds @properties['duration_seconds'] end |
#end_reason ⇒ ConferenceEndReason
410 411 412 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 410 def end_reason @properties['end_reason'] end |
#end_time ⇒ Time
368 369 370 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 368 def end_time @properties['end_time'] end |
#ended_by ⇒ String
416 417 418 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 416 def ended_by @properties['ended_by'] end |
#fetch ⇒ ConferenceInstance
Fetch the ConferenceInstance
477 478 479 480 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 477 def fetch context.fetch end |
#friendly_name ⇒ String
350 351 352 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 350 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
498 499 500 501 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 498 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Insights.V1.ConferenceInstance #{values}>" end |
#links ⇒ Hash
470 471 472 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 470 def links @properties['links'] end |
#max_concurrent_participants ⇒ String
398 399 400 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 398 def max_concurrent_participants @properties['max_concurrent_participants'] end |
#max_participants ⇒ String
392 393 394 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 392 def max_participants @properties['max_participants'] end |
#mixer_region ⇒ Region
422 423 424 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 422 def mixer_region @properties['mixer_region'] end |
#mixer_region_requested ⇒ Region
428 429 430 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 428 def mixer_region_requested @properties['mixer_region_requested'] end |
#processing_state ⇒ ProcessingState
458 459 460 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 458 def processing_state @properties['processing_state'] end |
#recording_enabled ⇒ Boolean
434 435 436 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 434 def recording_enabled @properties['recording_enabled'] end |
#start_time ⇒ Time
362 363 364 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 362 def start_time @properties['start_time'] end |
#status ⇒ ConferenceStatus
386 387 388 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 386 def status @properties['status'] end |
#tag_info ⇒ Hash
452 453 454 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 452 def tag_info @properties['tag_info'] end |
#tags ⇒ Array<Tag>
446 447 448 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 446 def @properties['tags'] end |
#to_s ⇒ Object
Provide a user friendly representation
491 492 493 494 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 491 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Insights.V1.ConferenceInstance #{values}>" end |
#unique_participants ⇒ String
404 405 406 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 404 def unique_participants @properties['unique_participants'] end |
#url ⇒ String
464 465 466 |
# File 'lib/twilio-ruby/rest/insights/v1/conference.rb', line 464 def url @properties['url'] end |