Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::MessageInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel/message.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the MessageInstance



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 317

def initialize(version, payload , service_sid: nil, channel_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'attributes' => payload['attributes'],
        'service_sid' => payload['service_sid'],
        'to' => payload['to'],
        'channel_sid' => payload['channel_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'last_updated_by' => payload['last_updated_by'],
        'was_edited' => payload['was_edited'],
        'from' => payload['from'],
        'body' => payload['body'],
        'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i,
        'type' => payload['type'],
        'media' => payload['media'],
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String 



364
365
366
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 364

def 
    @properties['account_sid']
end

#attributes ⇒ String 



370
371
372
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 370

def attributes
    @properties['attributes']
end

#body ⇒ String 



424
425
426
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 424

def body
    @properties['body']
end

#channel_sid ⇒ String 



388
389
390
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 388

def channel_sid
    @properties['channel_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



349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 349

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

#date_created ⇒ Time 



394
395
396
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 394

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



400
401
402
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 400

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance



456
457
458
459
460
461
462
463
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 456

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance



468
469
470
471
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 468

def fetch

    context.fetch
end

#from ⇒ String 



418
419
420
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 418

def from
    @properties['from']
end

#index ⇒ String 



430
431
432
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 430

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



513
514
515
516
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 513

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

#last_updated_by ⇒ String 



406
407
408
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 406

def last_updated_by
    @properties['last_updated_by']
end

#media ⇒ Hash 



442
443
444
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 442

def media
    @properties['media']
end

#service_sid ⇒ String 



376
377
378
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 376

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



358
359
360
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 358

def sid
    @properties['sid']
end

#to ⇒ String 



382
383
384
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 382

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



506
507
508
509
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 506

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

#type ⇒ String 



436
437
438
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 436

def type
    @properties['type']
end

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

Update the MessageInstance



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 483

def update(
    body: :unset, 
    attributes: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    last_updated_by: :unset, 
    from: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        body: body, 
        attributes: attributes, 
        date_created: date_created, 
        date_updated: date_updated, 
        last_updated_by: last_updated_by, 
        from: from, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String 



448
449
450
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 448

def url
    @properties['url']
end

#was_edited ⇒ Boolean 



412
413
414
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 412

def was_edited
    @properties['was_edited']
end