class Twilio::REST::Api::V2010::AccountContext::ConferenceInstance
Public Class Methods
Initialize the ConferenceInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] account_sid
The SID of the
{Account}[https://www.twilio.com/docs/iam/api/account] that created this Conference resource.
@param [String] sid The Twilio-provided string that uniquely identifies the
Conference resource to fetch
@return [ConferenceInstance] ConferenceInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 339 def initialize(version, payload, account_sid: nil, sid: nil) 340 super(version) 341 342 # Marshaled Properties 343 @properties = { 344 'account_sid' => payload['account_sid'], 345 'date_created' => Twilio.deserialize_rfc2822(payload['date_created']), 346 'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']), 347 'api_version' => payload['api_version'], 348 'friendly_name' => payload['friendly_name'], 349 'region' => payload['region'], 350 'sid' => payload['sid'], 351 'status' => payload['status'], 352 'uri' => payload['uri'], 353 'subresource_uris' => payload['subresource_uris'], 354 'reason_conference_ended' => payload['reason_conference_ended'], 355 'call_sid_ending_conference' => payload['call_sid_ending_conference'], 356 } 357 358 # Context 359 @instance_context = nil 360 @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], } 361 end
Public Instance Methods
@return [String] The SID of the Account that created this resource
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 376 def account_sid 377 @properties['account_sid'] 378 end
@return [String] The API version used to create this conference
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 394 def api_version 395 @properties['api_version'] 396 end
@return [String] The call SID that caused the conference to end
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 442 def call_sid_ending_conference 443 @properties['call_sid_ending_conference'] 444 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [ConferenceContext] ConferenceContext
for this ConferenceInstance
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 367 def context 368 unless @instance_context 369 @instance_context = ConferenceContext.new(@version, @params['account_sid'], @params['sid'], ) 370 end 371 @instance_context 372 end
@return [Time] The RFC 2822 date and time in GMT that this resource was created
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 382 def date_created 383 @properties['date_created'] 384 end
@return [Time] The RFC 2822 date and time in GMT that this resource was last updated
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 388 def date_updated 389 @properties['date_updated'] 390 end
Fetch the ConferenceInstance
@return [ConferenceInstance] Fetched ConferenceInstance
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 449 def fetch 450 context.fetch 451 end
@return [String] A string that you assigned to describe this conference room
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 400 def friendly_name 401 @properties['friendly_name'] 402 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 491 def inspect 492 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 493 "<Twilio.Api.V2010.ConferenceInstance #{values}>" 494 end
Access the participants @return [participants] participants
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 471 def participants 472 context.participants 473 end
@return [conference.ReasonConferenceEnded] The reason why a conference ended.
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 436 def reason_conference_ended 437 @properties['reason_conference_ended'] 438 end
Access the recordings @return [recordings] recordings
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 478 def recordings 479 context.recordings 480 end
@return [String] A string that represents the Twilio
Region where the conference was mixed
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 406 def region 407 @properties['region'] 408 end
@return [String] The unique string that identifies this resource
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 412 def sid 413 @properties['sid'] 414 end
@return [conference.Status] The status of this conference
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 418 def status 419 @properties['status'] 420 end
@return [String] A list of related resources identified by their relative URIs
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 430 def subresource_uris 431 @properties['subresource_uris'] 432 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 484 def to_s 485 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 486 "<Twilio.Api.V2010.ConferenceInstance #{values}>" 487 end
Update the ConferenceInstance
@param [conference.UpdateStatus] status The new status of the resource. Can be:
Can be: `init`, `in-progress`, or `completed`. Specifying `completed` will end the conference and hang up all participants
@param [String] announce_url The URL we should call to announce something into
the conference. The URL can return an MP3, a WAV, or a TwiML document with `<Play>` or `<Say>`.
@param [String] announce_method The HTTP
method used to call `announce_url`. Can
be: `GET` or `POST` and the default is `POST`
@return [ConferenceInstance] Updated ConferenceInstance
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 464 def update(status: :unset, announce_url: :unset, announce_method: :unset) 465 context.update(status: status, announce_url: announce_url, announce_method: announce_method, ) 466 end
@return [String] The URI of this resource, relative to `api.twilio.com`
# File lib/twilio-ruby/rest/api/v2010/account/conference.rb 424 def uri 425 @properties['uri'] 426 end