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

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Message resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 338

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

Returns:

  • (String) 


385
386
387
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 385

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


391
392
393
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 391

def attributes
    @properties['attributes']
end

#body ⇒ String

Returns:

  • (String) 


445
446
447
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 445

def body
    @properties['body']
end

#channel_sid ⇒ String

Returns:

  • (String) 


409
410
411
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 409

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

Returns:



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

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

Returns:

  • (Time) 


415
416
417
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 415

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


421
422
423
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 421

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance

Parameters:

  • x_twilio_webhook_enabled (MessageEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



477
478
479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 477

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



489
490
491
492
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 489

def fetch

    context.fetch
end

#from ⇒ String

Returns:

  • (String) 


439
440
441
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 439

def from
    @properties['from']
end

#index ⇒ String

Returns:

  • (String) 


451
452
453
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 451

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



534
535
536
537
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 534

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

#last_updated_by ⇒ String

Returns:

  • (String) 


427
428
429
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 427

def last_updated_by
    @properties['last_updated_by']
end

#media ⇒ Hash

Returns:

  • (Hash) 


463
464
465
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 463

def media
    @properties['media']
end

#service_sid ⇒ String

Returns:

  • (String) 


397
398
399
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 397

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


379
380
381
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 379

def sid
    @properties['sid']
end

#to ⇒ String

Returns:

  • (String) 


403
404
405
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 403

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



527
528
529
530
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 527

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

#type ⇒ String

Returns:

  • (String) 


457
458
459
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 457

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

Parameters:

  • body (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)
  • date_created (Time) (defaults to: :unset)
  • date_updated (Time) (defaults to: :unset)
  • last_updated_by (String) (defaults to: :unset)
  • from (String) (defaults to: :unset)
  • x_twilio_webhook_enabled (MessageEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 504

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

Returns:

  • (String) 


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

def url
    @properties['url']
end

#was_edited ⇒ Boolean

Returns:

  • (Boolean) 


433
434
435
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 433

def was_edited
    @properties['was_edited']
end