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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, flow_sid: nil, engagement_sid: nil, step_sid: nil) ⇒ StepContextInstance

Initialize the StepContextInstance

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

  • sid (String) —

    The SID of the Call resource to fetch.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 139

def initialize(version, payload , flow_sid: nil, engagement_sid: nil, step_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'context' => payload['context'],
        'engagement_sid' => payload['engagement_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']  ,'engagement_sid' => engagement_sid  || @properties['engagement_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 StepContext resource.

Returns:



170
171
172
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 170

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.



161
162
163
164
165
166
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 161

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

#engagement_sid ⇒ String

Returns The SID of the Engagement.

Returns:

  • (String) —

    The SID of the Engagement.



182
183
184
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 182

def engagement_sid
    @properties['engagement_sid']
end

#fetch ⇒ StepContextInstance

Fetch the StepContextInstance

Returns:



207
208
209
210
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/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.



188
189
190
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 188

def flow_sid
    @properties['flow_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



221
222
223
224
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 221

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

#step_sid ⇒ String

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

Returns:

  • (String) —

    The SID of the Step the context is associated with.



194
195
196
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 194

def step_sid
    @properties['step_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



214
215
216
217
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 214

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



200
201
202
 
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/step/step_context.rb', line 200

def url
    @properties['url']
end