Class: Twilio::REST::Studio::V1::FlowContext::ExecutionContext::ExecutionContextInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ExecutionContextInstance

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 ExecutionContext resource.

  • sid (String)

    The SID of the Call resource to fetch.



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_context.rb', line 136

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

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

Instance Method Details

#account_sidString

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

Returns:



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

def 
    @properties['account_sid']
end

#contextHash

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_context.rb', line 157

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

#execution_sidString

Returns The SID of the context’s Execution resource.

Returns:

  • (String)

    The SID of the context’s Execution resource.



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

def execution_sid
    @properties['execution_sid']
end

#fetchExecutionContextInstance

Fetch the ExecutionContextInstance

Returns:



197
198
199
200
# File 'lib/twilio-ruby/rest/studio/v1/flow/execution/execution_context.rb', line 197

def fetch

    context.fetch
end

#flow_sidString

Returns The SID of the Flow.

Returns:

  • (String)

    The SID of the Flow.



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

def flow_sid
    @properties['flow_sid']
end

#inspectObject

Provide a detailed, user friendly representation



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

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

#to_sObject

Provide a user friendly representation



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

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

#urlString

Returns The absolute URL of the resource.

Returns:

  • (String)

    The absolute URL of the resource.



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

def url
    @properties['url']
end