Class: Twilio::REST::Studio::V1::FlowContext::EngagementContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Studio::V1::FlowContext::EngagementContext
- Defined in:
- lib/twilio-ruby/rest/studio/v1/flow/engagement.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb
Defined Under Namespace
Classes: EngagementContextContext, EngagementContextInstance, EngagementContextList, EngagementContextPage, StepContext, StepInstance, StepList, StepPage
Instance Method Summary collapse
-
#delete ⇒ Boolean
Delete the EngagementInstance.
-
#engagement_context ⇒ EngagementContextList, EngagementContextContext
Access the engagement_context.
-
#fetch ⇒ EngagementInstance
Fetch the EngagementInstance.
-
#initialize(version, flow_sid, sid) ⇒ EngagementContext
constructor
Initialize the EngagementContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#steps(sid = :unset) ⇒ StepList, StepContext
Access the steps.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, flow_sid, sid) ⇒ EngagementContext
Initialize the EngagementContext
162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 162 def initialize(version, flow_sid, sid) super(version) # Path Solution @solution = { flow_sid: flow_sid, sid: sid, } @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:sid]}" # Dependents @steps = nil @engagement_context = nil end |
Instance Method Details
#delete ⇒ Boolean
Delete the EngagementInstance
176 177 178 179 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 176 def delete @version.delete('DELETE', @uri) end |
#engagement_context ⇒ EngagementContextList, EngagementContextContext
Access the engagement_context
218 219 220 221 222 223 224 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 218 def engagement_context EngagementContextContext.new( @version, @solution[:flow_sid], @solution[:sid] ) end |
#fetch ⇒ EngagementInstance
Fetch the EngagementInstance
184 185 186 187 188 189 190 191 192 193 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 184 def fetch payload = @version.fetch('GET', @uri) EngagementInstance.new( @version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
235 236 237 238 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 235 def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Studio.V1.EngagementContext #{context}>" end |
#steps(sid = :unset) ⇒ StepList, StepContext
Access the steps
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 199 def steps(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return StepContext.new(@version, @solution[:flow_sid], @solution[:sid],sid ) end unless @steps @steps = StepList.new( @version, flow_sid: @solution[:flow_sid], engagement_sid: @solution[:sid], ) end @steps end |
#to_s ⇒ Object
Provide a user friendly representation
228 229 230 231 |
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 228 def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Studio.V1.EngagementContext #{context}>" end |