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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The service_sid

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

    The channel_sid

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

    The sid



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 300

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'].to_i,
      'type' => payload['type'],
      'media' => payload['media'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The attributes.

Returns:

  • (String) —

    The attributes



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

def attributes
  @properties['attributes']
end

#body ⇒ String

Returns The body.

Returns:

  • (String) —

    The body



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

def body
  @properties['body']
end

#channel_sid ⇒ String

Returns The channel_sid.

Returns:

  • (String) —

    The channel_sid



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

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:



336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 336

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 The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



454
455
456
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 454

def delete
  context.delete
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

Returns:



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

def fetch
  context.fetch
end

#from ⇒ String

Returns The from.

Returns:

  • (String) —

    The from



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

def from
  @properties['from']
end

#index ⇒ String

Returns The index.

Returns:

  • (String) —

    The index



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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



485
486
487
488
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 485

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

#last_updated_by ⇒ String

Returns The last_updated_by.

Returns:

  • (String) —

    The last_updated_by



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

def last_updated_by
  @properties['last_updated_by']
end

#media ⇒ Hash

Returns The media.

Returns:

  • (Hash) —

    The media



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

def media
  @properties['media']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to ⇒ String

Returns The to.

Returns:

  • (String) —

    The to



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



478
479
480
481
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/message.rb', line 478

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

#type ⇒ String

Returns The type.

Returns:

  • (String) —

    The type



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

def type
  @properties['type']
end

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

Update the MessageInstance

Parameters:

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

    The body

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

    The attributes

  • date_created (Time) (defaults to: :unset) —

    The date_created

  • date_updated (Time) (defaults to: :unset) —

    The date_updated

  • last_updated_by (String) (defaults to: :unset) —

    The last_updated_by

Returns:



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

def update(body: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, last_updated_by: :unset)
  context.update(
      body: body,
      attributes: attributes,
      date_created: date_created,
      date_updated: date_updated,
      last_updated_by: last_updated_by,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#was_edited ⇒ Boolean

Returns The was_edited.

Returns:

  • (Boolean) —

    The was_edited



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

def was_edited
  @properties['was_edited']
end