Class: Twilio::REST::Api::V2010::AccountContext::ConferenceContext

Inherits:

InstanceContext

• Object
• InstanceContext
• Twilio::REST::Api::V2010::AccountContext::ConferenceContext

Defined in:

lib/twilio-ruby/rest/api/v2010/account/conference.rb,
lib/twilio-ruby/rest/api/v2010/account/conference/participant.rb

Defined Under Namespace

Classes: ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage

Instance Method Summary

• #fetch ⇒ ConferenceInstance

  Fetch a ConferenceInstance.

• #initialize(version, account_sid, sid) ⇒ ConferenceContext constructor

  Initialize the ConferenceContext.

• #participants(call_sid = :unset) ⇒ ParticipantList, ParticipantContext

  Access the participants.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(status: :unset) ⇒ ConferenceInstance

  Update the ConferenceInstance.

Constructor Details

#initialize(version, account_sid, sid) ⇒ ConferenceContext

Initialize the ConferenceContext

Parameters:

• version (Version) —

  Version that contains the resource

• account_sid (String) —

  The account_sid

• sid (String) —

  The conference Sid that uniquely identifies this resource

# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 219

def initialize(version, account_sid, sid)
  super(version)

  # Path Solution
  @solution = {
      account_sid: account_sid,
      sid: sid,
  }
  @uri = "/Accounts/#{@solution[:account_sid]}/Conferences/#{@solution[:sid]}.json"

  # Dependents
  @participants = nil
end

Instance Method Details

#fetch ⇒ ConferenceInstance

Fetch a ConferenceInstance

Returns:

• (ConferenceInstance) —

  Fetched ConferenceInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 236

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  ConferenceInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end

#participants(call_sid = :unset) ⇒ ParticipantList, ParticipantContext

Access the participants

Returns:

• (ParticipantList)
• (ParticipantContext) —

  if call_sid was passed.

Raises:

• (ArgumentError)

# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 280

def participants(call_sid=:unset)
  raise ArgumentError, 'call_sid cannot be nil' if call_sid.nil?

  if call_sid != :unset
    return ParticipantContext.new(
        @version,
        @solution[:account_sid],
        @solution[:sid],
        call_sid,
    )
  end

  unless @participants
    @participants = ParticipantList.new(
        @version,
        account_sid: @solution[:account_sid],
        conference_sid: @solution[:sid],
    )
  end

  @participants
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 305

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Api.V2010.ConferenceContext #{context}>"
end

#update(status: :unset) ⇒ ConferenceInstance

Update the ConferenceInstance

Parameters:

• status (conference.UpdateStatus) (defaults to: :unset) —

  The status

Returns:

• (ConferenceInstance) —

  Updated ConferenceInstance

# File 'lib/twilio-ruby/rest/api/v2010/account/conference.rb', line 257

def update(status: :unset)
  data = Twilio::Values.of({
      'Status' => status,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  ConferenceInstance.new(
      @version,
      payload,
      account_sid: @solution[:account_sid],
      sid: @solution[:sid],
  )
end