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

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 290

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']),
        'was_edited' => payload['was_edited'],
        'from' => payload['from'],
        'body' => payload['body'],
        'index' => payload['index'] == nil ? payload['index'] : payload['index'].to_i,
        '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) 


334
335
336
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 334

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


340
341
342
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 340

def attributes
    @properties['attributes']
end

#body ⇒ String

Returns:

  • (String) 


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

def body
    @properties['body']
end

#channel_sid ⇒ String

Returns:

  • (String) 


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

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:



319
320
321
322
323
324
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 319

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) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessageInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



407
408
409
410
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 407

def delete

    context.delete
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



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

def fetch

    context.fetch
end

#from ⇒ String

Returns:

  • (String) 


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

def from
    @properties['from']
end

#index ⇒ String

Returns:

  • (String) 


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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#service_sid ⇒ String

Returns:

  • (String) 


346
347
348
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 346

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


328
329
330
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 328

def sid
    @properties['sid']
end

#to ⇒ String

Returns:

  • (String) 


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

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(body: :unset, attributes: :unset) ⇒ MessageInstance

Update the MessageInstance

Parameters:

  • body (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)

Returns:



425
426
427
428
429
430
431
432
433
434
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel/message.rb', line 425

def update(
    body: :unset, 
    attributes: :unset
)

    context.update(
        body: body, 
        attributes: attributes, 
    )
end

#url ⇒ String

Returns:

  • (String) 


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

def url
    @properties['url']
end

#was_edited ⇒ Boolean

Returns:

  • (Boolean) 


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

def was_edited
    @properties['was_edited']
end