Class: Twilio::REST::Api::V2010::AccountContext::CallContext::StreamInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/call/stream.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, call_sid: nil, sid: nil) ⇒ StreamInstance

Initialize the StreamInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Account that created this Stream resource.

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

    The SID of the Call resource to fetch.



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 765

def initialize(version, payload , account_sid: nil, call_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'call_sid' => payload['call_sid'],
        'name' => payload['name'],
        'status' => payload['status'],
        'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
        'uri' => payload['uri'],
    }

    # Context
    @instance_context = nil
    @params = { 'account_sid' =>   ,'call_sid' => call_sid  || @properties['call_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created this Stream resource.

Returns:



803
804
805
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 803

def 
    @properties['account_sid']
end

#call_sid ⇒ String

Returns The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Stream resource is associated with.

Returns:



809
810
811
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 809

def call_sid
    @properties['call_sid']
end

#context ⇒ StreamContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



788
789
790
791
792
793
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 788

def context
    unless @instance_context
        @instance_context = StreamContext.new(@version , @params['account_sid'], @params['call_sid'], @params['sid'])
    end
    @instance_context
end

#date_updated ⇒ Time

Returns The date and time in GMT that this resource was last updated, specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



827
828
829
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 827

def date_updated
    @properties['date_updated']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



859
860
861
862
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 859

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Api.V2010.StreamInstance #{values}>"
end

#name ⇒ String

Returns The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream.

Returns:

  • (String) —

    The user-specified name of this Stream, if one was given when the Stream was created. This may be used to stop the Stream.



815
816
817
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 815

def name
    @properties['name']
end

#sid ⇒ String

Returns The SID of the Stream resource.

Returns:

  • (String) —

    The SID of the Stream resource.



797
798
799
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 797

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


821
822
823
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 821

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



852
853
854
855
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 852

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Api.V2010.StreamInstance #{values}>"
end

#update(status: nil) ⇒ StreamInstance

Update the StreamInstance

Parameters:

  • status (UpdateStatus) (defaults to: nil)

Returns:



841
842
843
844
845
846
847
848
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 841

def update(
    status: nil
)

    context.update(
        status: status, 
    )
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`.



833
834
835
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/stream.rb', line 833

def uri
    @properties['uri']
end