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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb,
lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb

Defined Under Namespace

Classes: StepContextContext, StepContextInstance, StepContextList, StepContextPage

Instance Method Summary collapse

Constructor Details

#initialize(version, flow_sid, engagement_sid, sid) ⇒ StepContext

Initialize the StepContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • flow_sid (String) —

    The SID of the Flow with the Step to fetch.

  • engagement_sid (String) —

    The SID of the Engagement with the Step to fetch.

  • sid (String) —

    The SID of the Step resource to fetch.



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 138

def initialize(version, flow_sid, engagement_sid, sid)
    super(version)

    # Path Solution
    @solution = { flow_sid: flow_sid, engagement_sid: engagement_sid, sid: sid,  }
    @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:engagement_sid]}/Steps/#{@solution[:sid]}"

    # Dependents
    @step_context = nil
end

Instance Method Details

#fetch ⇒ StepInstance

Fetch the StepInstance

Returns:



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 151

def fetch

    payload = @version.fetch('GET', @uri)
    StepInstance.new(
        @version,
        payload,
        flow_sid: @solution[:flow_sid],
        engagement_sid: @solution[:engagement_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



185
186
187
188
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 185

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

#step_context ⇒ StepContextList, StepContextContext

Access the step_context

Returns:



167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 167

def step_context
    StepContextContext.new(
            @version,
            @solution[:flow_sid],
            @solution[:engagement_sid],
            @solution[:sid]
            )
end

#to_s ⇒ Object

Provide a user friendly representation



178
179
180
181
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step.rb', line 178

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