Class: Twilio::REST::Preview::Understand::AssistantContext::DialogueInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ DialogueInstance

Initialize the DialogueInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • assistant_sid (String) (defaults to: nil)

    The unique ID of the parent Assistant.

  • sid (String) (defaults to: nil)

    The sid


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 123

def initialize(version, payload, assistant_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'assistant_sid' => payload['assistant_sid'],
      'sid' => payload['sid'],
      'data' => payload['data'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sidString

Returns The unique ID of the Account that created this Field.

Returns:

  • (String)

    The unique ID of the Account that created this Field.


153
154
155
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 153

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The unique ID of the parent Assistant.

Returns:

  • (String)

    The unique ID of the parent Assistant.


159
160
161
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 159

def assistant_sid
  @properties['assistant_sid']
end

#contextDialogueContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


144
145
146
147
148
149
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 144

def context
  unless @instance_context
    @instance_context = DialogueContext.new(@version, @params['assistant_sid'], @params['sid'], )
  end
  @instance_context
end

#dataHash

Returns The dialogue memory object as json.

Returns:

  • (Hash)

    The dialogue memory object as json


171
172
173
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 171

def data
  @properties['data']
end

#fetchDialogueInstance

Fetch the DialogueInstance

Returns:


184
185
186
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 184

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


197
198
199
200
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 197

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

#sidString

Returns The unique ID of the Dialogue.

Returns:

  • (String)

    The unique ID of the Dialogue


165
166
167
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 165

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


190
191
192
193
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 190

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

#urlString

Returns The url.

Returns:

  • (String)

    The url


177
178
179
# File 'lib/twilio-ruby/rest/preview/understand/assistant/dialogue.rb', line 177

def url
  @properties['url']
end