Class: Twilio::REST::Trunking::V1::TrunkContext::RecordingInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, trunk_sid: nil) ⇒ RecordingInstance

Initialize the RecordingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The trunk_sid



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 118

def initialize(version, payload, trunk_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'mode' => payload['mode'],
      'trim' => payload['trim'],
      'url' => payload['url'],
      'trunk_sid' => payload['trunk_sid'],
  }

  # Context
  @instance_context = nil
  @params = {'trunk_sid' => trunk_sid, }
end

Instance Method Details

#context ⇒ RecordingContext

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

Returns:



138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 138

def context
  unless @instance_context
    @instance_context = RecordingContext.new(@version, @params['trunk_sid'], )
  end
  @instance_context
end

#fetch ⇒ RecordingInstance

Fetch the RecordingInstance

Returns:



172
173
174
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 172

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



192
193
194
195
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 192

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

#mode ⇒ recording.RecordingMode

Returns The recording mode for the trunk.

Returns:

  • (recording.RecordingMode) —

    The recording mode for the trunk.



147
148
149
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 147

def mode
  @properties['mode']
end

#to_s ⇒ Object

Provide a user friendly representation



185
186
187
188
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 185

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

#trim ⇒ recording.RecordingTrim

Returns The recording trim setting for the trunk.

Returns:

  • (recording.RecordingTrim) —

    The recording trim setting for the trunk.



153
154
155
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 153

def trim
  @properties['trim']
end

#trunk_sid ⇒ String

Returns The trunk_sid.

Returns:

  • (String) —

    The trunk_sid



165
166
167
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 165

def trunk_sid
  @properties['trunk_sid']
end

#update ⇒ RecordingInstance

Update the RecordingInstance

Returns:



179
180
181
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 179

def update
  context.update
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



159
160
161
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/recording.rb', line 159

def url
  @properties['url']
end