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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MessageInstance



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 336

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'chat_service_sid' => payload['chat_service_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']),
      'delivery' => payload['delivery'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String 



385
386
387
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 385

def 
  @properties['account_sid']
end

#attributes ⇒ String 



433
434
435
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 433

def attributes
  @properties['attributes']
end

#author ⇒ String 



415
416
417
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 415

def author
  @properties['author']
end

#body ⇒ String 



421
422
423
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 421

def body
  @properties['body']
end

#chat_service_sid ⇒ String 



391
392
393
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 391

def chat_service_sid
  @properties['chat_service_sid']
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



371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 371

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

#conversation_sid ⇒ String 



397
398
399
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 397

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time 



445
446
447
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 445

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



451
452
453
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 451

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



504
505
506
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 504

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

#delivery ⇒ Hash 



457
458
459
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 457

def delivery
  @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts



518
519
520
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 518

def delivery_receipts
  context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



511
512
513
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 511

def fetch
  context.fetch
end

#index ⇒ String 



409
410
411
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 409

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



531
532
533
534
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 531

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

#links ⇒ String 



469
470
471
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 469

def links
  @properties['links']
end

#media ⇒ Array[Hash] 



427
428
429
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 427

def media
  @properties['media']
end

#participant_sid ⇒ String 



439
440
441
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 439

def participant_sid
  @properties['participant_sid']
end

#sid ⇒ String 



403
404
405
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 403

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



524
525
526
527
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 524

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



488
489
490
491
492
493
494
495
496
497
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 488

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 



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

def url
  @properties['url']
end