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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Studio::V1::FlowContext::ExecutionContext::ExecutionStepContext::ExecutionStepContextInstance

Defined in:

lib/twilio-ruby/rest/studio/v1/flow/execution/execution_step/execution_step_context.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #context ⇒ Hash

  The current state of the Flow’s Execution.

• #execution_sid ⇒ String

  The SID of the context’s Execution resource.

• #fetch ⇒ ExecutionStepContextInstance

  Fetch the ExecutionStepContextInstance.

• #flow_sid ⇒ String

  The SID of the Flow.

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

  Initialize the ExecutionStepContextInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #step_sid ⇒ String

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

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the resource.

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.

[View on GitHub]

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

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:

• (String) —

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

[View on GitHub]

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

def account_sid
    @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.

[View on GitHub]

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

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.

[View on GitHub]

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

def execution_sid
    @properties['execution_sid']
end

#fetch ⇒ ExecutionStepContextInstance

Fetch the ExecutionStepContextInstance

Returns:

• (ExecutionStepContextInstance) —

  Fetched ExecutionStepContextInstance

[View on GitHub]

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

def fetch

    context.fetch
end

#flow_sid ⇒ String

Returns The SID of the Flow.

Returns:

• (String) —

  The SID of the Flow.

[View on GitHub]

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

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

[View on GitHub]

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

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.

[View on GitHub]

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

def step_sid
    @properties['step_sid']
end

#to_s ⇒ Object

Provide a user friendly representation

[View on GitHub]

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

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.

[View on GitHub]

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

def url
    @properties['url']
end