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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 263

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'].to_i,
      '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 



316
317
318
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 316

def 
  @properties['account_sid']
end

#attributes ⇒ String 



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

def attributes
  @properties['attributes']
end

#body ⇒ String 



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

def body
  @properties['body']
end

#channel_sid ⇒ String 



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

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



296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 296

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 



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance



396
397
398
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 396

def delete
  context.delete
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance



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

def fetch
  context.fetch
end

#from ⇒ String 



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

def from
  @properties['from']
end

#index ⇒ String 



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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#service_sid ⇒ String 



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



310
311
312
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 310

def sid
  @properties['sid']
end

#to ⇒ String 



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

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

Update the MessageInstance



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

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

#url ⇒ String 



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

def url
  @properties['url']
end

#was_edited ⇒ Boolean 



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

def was_edited
  @properties['was_edited']
end