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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 347

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 



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

def 
    @properties['account_sid']
end

#attributes ⇒ String 



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

def attributes
    @properties['attributes']
end

#author ⇒ String 



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

def author
    @properties['author']
end

#body ⇒ String 



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

def body
    @properties['body']
end

#chat_service_sid ⇒ String 



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

def chat_service_sid
    @properties['chat_service_sid']
end

#content_sid ⇒ String 



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

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



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

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 



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

def conversation_sid
    @properties['conversation_sid']
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



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

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#delivery ⇒ Hash 



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

def delivery
    @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts



537
538
539
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 537

def delivery_receipts
    context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



498
499
500
501
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 498

def fetch

    context.fetch
end

#index ⇒ String 



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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



550
551
552
553
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 550

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#media ⇒ Array<Hash> 



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

def media
    @properties['media']
end

#participant_sid ⇒ String 



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

def participant_sid
    @properties['participant_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



543
544
545
546
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 543

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



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 513

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 



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

def url
    @properties['url']
end