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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the MessageInstance



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 359

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'] == 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']),
        'url' => payload['url'],
        'delivery' => payload['delivery'],
        'links' => payload['links'],
        'content_sid' => payload['content_sid'],
    }

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

Instance Method Details

#account_sid ⇒ String 



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

def 
    @properties['account_sid']
end

#attributes ⇒ String 



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

def attributes
    @properties['attributes']
end

#author ⇒ String 



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

def author
    @properties['author']
end

#body ⇒ String 



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

def body
    @properties['body']
end

#content_sid ⇒ String 



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

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



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

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

#conversation_sid ⇒ String 



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

def conversation_sid
    @properties['conversation_sid']
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



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

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#delivery ⇒ Hash 



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

def delivery
    @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts



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

def delivery_receipts
    context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



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

def fetch

    context.fetch
end

#index ⇒ String 



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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#media ⇒ Array<Hash> 



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

def media
    @properties['media']
end

#participant_sid ⇒ String 



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

def participant_sid
    @properties['participant_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



548
549
550
551
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 548

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



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 518

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 



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

def url
    @properties['url']
end