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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 364

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'] == nil ? payload['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'],
        'content_sid' => payload['content_sid'],
    }

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

Instance Method Details

#account_sid ⇒ String 



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

def 
    @properties['account_sid']
end

#attributes ⇒ String 



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

def attributes
    @properties['attributes']
end

#author ⇒ String 



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

def author
    @properties['author']
end

#body ⇒ String 



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

def body
    @properties['body']
end

#chat_service_sid ⇒ String 



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

def chat_service_sid
    @properties['chat_service_sid']
end

#content_sid ⇒ String 



495
496
497
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 495

def content_sid
    @properties['content_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



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

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 



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

def conversation_sid
    @properties['conversation_sid']
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



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

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#delivery ⇒ Hash 



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

def delivery
    @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts



554
555
556
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 554

def delivery_receipts
    context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



515
516
517
518
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 515

def fetch

    context.fetch
end

#index ⇒ String 



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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



567
568
569
570
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 567

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

#links ⇒ Hash 



489
490
491
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 489

def links
    @properties['links']
end

#media ⇒ Array<Hash> 



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

def media
    @properties['media']
end

#participant_sid ⇒ String 



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

def participant_sid
    @properties['participant_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



560
561
562
563
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 560

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, subject: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance

Update the MessageInstance



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 530

def update(
    author: :unset, 
    body: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    subject: :unset, 
    x_twilio_webhook_enabled: :unset
)

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

#url ⇒ String 



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

def url
    @properties['url']
end