Class: Twilio::REST::Studio::V1::FlowContext::EngagementContext::EngagementContextInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the EngagementContextInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • flow_sid (String) (defaults to: nil)

    The SID of the Flow.

  • engagement_sid (String) (defaults to: nil)

    The SID of the Engagement.


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb', line 122

def initialize(version, payload, flow_sid: nil, engagement_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'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'flow_sid' => flow_sid, 'engagement_sid' => engagement_sid, }
end

Instance Method Details

#account_sidString

Returns Account SID.

Returns:

  • (String)

    Account SID


156
157
158
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb', line 156

def 
  @properties['account_sid']
end

#contextHash

Returns Flow state.

Returns:

  • (Hash)

    Flow state


143
144
145
146
147
148
149
150
151
152
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb', line 143

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

#engagement_sidString

Returns Engagement SID.

Returns:

  • (String)

    Engagement SID


168
169
170
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb', line 168

def engagement_sid
  @properties['engagement_sid']
end

#fetchEngagementContextInstance

Fetch the EngagementContextInstance

Returns:


187
188
189
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb', line 187

def fetch
  context.fetch
end

#flow_sidString

Returns Flow SID.

Returns:

  • (String)

    Flow SID


174
175
176
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb', line 174

def flow_sid
  @properties['flow_sid']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#to_sObject

Provide a user friendly representation


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

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

#urlString

Returns The URL of the resource.

Returns:

  • (String)

    The URL of the resource


180
181
182
# File 'lib/twilio-ruby/rest/studio/v1/flow/engagement/engagement_context.rb', line 180

def url
  @properties['url']
end