Class: Twilio::REST::Preview::Understand::AssistantContext::TaskContext::FieldInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Preview::Understand::AssistantContext::TaskContext::FieldInstance
- Defined in:
- lib/twilio-ruby/rest/preview/understand/assistant/task/field.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
-
#account_sid ⇒ String
The unique ID of the Account that created this Field.
-
#assistant_sid ⇒ String
The unique ID of the parent Assistant.
-
#context ⇒ FieldContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The date that this resource was created.
-
#date_updated ⇒ Time
The date that this resource was last updated.
-
#delete ⇒ Boolean
Delete the FieldInstance.
-
#fetch ⇒ FieldInstance
Fetch the FieldInstance.
-
#field_type ⇒ String
The Field Type of this field.
-
#initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil) ⇒ FieldInstance
constructor
Initialize the FieldInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#sid ⇒ String
A 34 character string that uniquely identifies this resource.
-
#task_sid ⇒ String
The unique ID of the Task associated with this Field.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
A user-provided string that uniquely identifies this resource as an alternative to the sid.
-
#url ⇒ String
The url.
Constructor Details
#initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil) ⇒ FieldInstance
Initialize the FieldInstance
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 245 def initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'field_type' => payload['field_type'], 'task_sid' => payload['task_sid'], 'assistant_sid' => payload['assistant_sid'], 'sid' => payload['sid'], 'unique_name' => payload['unique_name'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'assistant_sid' => assistant_sid, 'task_sid' => task_sid, 'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique ID of the Account that created this Field.
288 289 290 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 288 def account_sid @properties['account_sid'] end |
#assistant_sid ⇒ String
Returns The unique ID of the parent Assistant.
318 319 320 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 318 def assistant_sid @properties['assistant_sid'] end |
#context ⇒ FieldContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 274 def context unless @instance_context @instance_context = FieldContext.new( @version, @params['assistant_sid'], @params['task_sid'], @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
Returns The date that this resource was created.
294 295 296 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 294 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this resource was last updated.
300 301 302 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 300 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the FieldInstance
350 351 352 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 350 def delete context.delete end |
#fetch ⇒ FieldInstance
Fetch the FieldInstance
343 344 345 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 343 def fetch context.fetch end |
#field_type ⇒ String
Returns The Field Type of this field. It can be any Built-in Field Type or unique_name or the Field Type sid of a custom Field Type.
306 307 308 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 306 def field_type @properties['field_type'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
363 364 365 366 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 363 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.Understand.FieldInstance #{values}>" end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
324 325 326 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 324 def sid @properties['sid'] end |
#task_sid ⇒ String
Returns The unique ID of the Task associated with this Field.
312 313 314 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 312 def task_sid @properties['task_sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
356 357 358 359 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 356 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.Understand.FieldInstance #{values}>" end |
#unique_name ⇒ String
Returns A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
330 331 332 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 330 def unique_name @properties['unique_name'] end |
#url ⇒ String
Returns The url.
336 337 338 |
# File 'lib/twilio-ruby/rest/preview/understand/assistant/task/field.rb', line 336 def url @properties['url'] end |