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.



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

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) 


367
368
369
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 367

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


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

def attributes
    @properties['attributes']
end

#body ⇒ String

Returns:

  • (String) 


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

def body
    @properties['body']
end

#channel_sid ⇒ String

Returns:

  • (String) 


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

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:



352
353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 352

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) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

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



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

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



471
472
473
474
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 471

def fetch

    context.fetch
end

#from ⇒ String

Returns:

  • (String) 


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

def from
    @properties['from']
end

#index ⇒ String

Returns:

  • (String) 


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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



516
517
518
519
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 516

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

#last_updated_by ⇒ String

Returns:

  • (String) 


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

def last_updated_by
    @properties['last_updated_by']
end

#media ⇒ Hash

Returns:

  • (Hash) 


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

def media
    @properties['media']
end

#service_sid ⇒ String

Returns:

  • (String) 


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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


361
362
363
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 361

def sid
    @properties['sid']
end

#to ⇒ String

Returns:

  • (String) 


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

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



509
510
511
512
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/channel/message.rb', line 509

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

#type ⇒ String

Returns:

  • (String) 


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

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:



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

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) 


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

def url
    @properties['url']
end

#was_edited ⇒ Boolean

Returns:

  • (Boolean) 


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

def was_edited
    @properties['was_edited']
end