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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/studio/v2/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.



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

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:



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

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.



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

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.



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

def execution_sid
    @properties['execution_sid']
end

#fetch ⇒ ExecutionStepContextInstance

Fetch the ExecutionStepContextInstance

Returns:



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

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

  • (String) —

    The SID of the Flow.



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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Studio.V2.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.



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

def step_sid
    @properties['step_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end