Class: Twilio::REST::Studio::V1::FlowContext::EngagementContext

Inherits:
InstanceContext
  • Object
show all
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

Constructor Details

#initialize(version, flow_sid, sid) ⇒ EngagementContext

Initialize the EngagementContext

Parameters:

  • version (Version)

    Version that contains the resource

  • flow_sid (String)

    The SID of the Flow.

  • sid (String)

    The SID of the Engagement resource to fetch.


178
179
180
181
182
183
184
185
186
187
188
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 178

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

#deleteBoolean

Delete the EngagementInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


202
203
204
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 202

def delete
   @version.delete('DELETE', @uri)
end

#engagement_contextEngagementContextList, EngagementContextContext

Access the engagement_context


228
229
230
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 228

def engagement_context
  EngagementContextContext.new(@version, @solution[:flow_sid], @solution[:sid], )
end

#fetchEngagementInstance

Fetch the EngagementInstance

Returns:


193
194
195
196
197
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 193

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

  EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


241
242
243
244
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 241

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Studio.V1.EngagementContext #{context}>"
end

#steps(sid = :unset) ⇒ StepList, StepContext

Access the steps

Returns:

Raises:

  • (ArgumentError)

210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 210

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_sObject

Provide a user friendly representation


234
235
236
237
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement.rb', line 234

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