Class: Twilio::REST::Conversations::V1::ConversationContext::MessageInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/message.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, conversation_sid: nil, sid: nil) ⇒ MessageInstance

Initialize the MessageInstance



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 312

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'conversation_sid' => payload['conversation_sid'],
      'sid' => payload['sid'],
      'index' => payload['index'].to_i,
      'author' => payload['author'],
      'body' => payload['body'],
      'media' => payload['media'],
      'attributes' => payload['attributes'],
      'participant_sid' => payload['participant_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'delivery' => payload['delivery'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String 



351
352
353
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 351

def 
  @properties['account_sid']
end

#attributes ⇒ String 



393
394
395
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 393

def attributes
  @properties['attributes']
end

#author ⇒ String 



375
376
377
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 375

def author
  @properties['author']
end

#body ⇒ String 



381
382
383
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 381

def body
  @properties['body']
end

#context ⇒ MessageContext

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



342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 342

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

#conversation_sid ⇒ String 



357
358
359
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 357

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time 



405
406
407
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 405

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



411
412
413
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 411

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



464
465
466
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 464

def delete(x_twilio_webhook_enabled: :unset)
  context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
end

#delivery ⇒ Hash 



423
424
425
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 423

def delivery
  @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts



478
479
480
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 478

def delivery_receipts
  context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



471
472
473
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 471

def fetch
  context.fetch
end

#index ⇒ String 



369
370
371
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 369

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



491
492
493
494
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 491

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

#links ⇒ String 



429
430
431
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 429

def links
  @properties['links']
end

#media ⇒ Hash 



387
388
389
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 387

def media
  @properties['media']
end

#participant_sid ⇒ String 



399
400
401
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 399

def participant_sid
  @properties['participant_sid']
end

#sid ⇒ String 



363
364
365
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 363

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



484
485
486
487
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 484

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

#update(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance

Update the MessageInstance



448
449
450
451
452
453
454
455
456
457
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 448

def update(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, x_twilio_webhook_enabled: :unset)
  context.update(
      author: author,
      body: body,
      date_created: date_created,
      date_updated: date_updated,
      attributes: attributes,
      x_twilio_webhook_enabled: x_twilio_webhook_enabled,
  )
end

#url ⇒ String 



417
418
419
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 417

def url
  @properties['url']
end