Class: Twilio::REST::Studio::V1::FlowContext::ExecutionContext::ExecutionStepContext::ExecutionStepContextInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, flow_sid: nil, execution_sid: nil, step_sid: nil) ⇒ ExecutionStepContextInstance

Initialize the ExecutionStepContextInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ExecutionStepContext resource.

  • sid (String) —

    The SID of the Call resource to fetch.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 135

def initialize(version, payload , flow_sid: nil, execution_sid: nil, step_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'context' => payload['context'],
        'execution_sid' => payload['execution_sid'],
        'flow_sid' => payload['flow_sid'],
        'step_sid' => payload['step_sid'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'flow_sid' => flow_sid  || @properties['flow_sid']  ,'execution_sid' => execution_sid  || @properties['execution_sid']  ,'step_sid' => step_sid  || @properties['step_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



166
167
168
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 166

def 
    @properties['account_sid']
end

#context ⇒ Hash

Returns The current state of the Flow’s Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.

Returns:

  • (Hash) —

    The current state of the Flow’s Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution.



157
158
159
160
161
162
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 157

def context
    unless @instance_context
        @instance_context = ExecutionStepContextContext.new(@version , @params['flow_sid'], @params['execution_sid'], @params['step_sid'])
    end
    @instance_context
end

#execution_sid ⇒ String

Returns The SID of the context’s Execution resource.

Returns:

  • (String) —

    The SID of the context’s Execution resource.



178
179
180
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 178

def execution_sid
    @properties['execution_sid']
end

#fetch ⇒ ExecutionStepContextInstance

Fetch the ExecutionStepContextInstance

Returns:



203
204
205
206
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 203

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



184
185
186
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 184

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



217
218
219
220
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 217

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

#step_sid ⇒ String

Returns The SID of the Step that the context is associated with.

Returns:

  • (String) —

    The SID of the Step that the context is associated with.



190
191
192
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 190

def step_sid
    @properties['step_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



210
211
212
213
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 210

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



196
197
198
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb', line 196

def url
    @properties['url']
end