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

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.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 283

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 The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Message resource.

Returns:



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

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data. Note If this property has been assigned a value, it’s only displayed in a FETCH action that returns a single resource; otherwise, it’s null. If the attributes have not been set, ‘{}` is returned.

Returns:

  • (String) —

    The JSON string that stores application-specific data. Note If this property has been assigned a value, it’s only displayed in a FETCH action that returns a single resource; otherwise, it’s null. If the attributes have not been set, ‘{}` is returned.



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

def attributes
    @properties['attributes']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message.



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

def body
    @properties['body']
end

#channel_sid ⇒ String

Returns The unique ID of the [Channel](www.twilio.com/docs/api/chat/rest/channels) the Message resource belongs to.

Returns:



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

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:



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

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 and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessageInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



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

def fetch

    context.fetch
end

#from ⇒ String

Returns The [identity](www.twilio.com/docs/api/chat/guides/identity) of the message’s author. The default value is ‘system`.

Returns:



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

def from
    @properties['from']
end

#index ⇒ String

Returns The index of the message within the [Channel](www.twilio.com/docs/chat/api/channels).

Returns:



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

def index
    @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/api/chat/rest/services) the resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Message resource.

Returns:

  • (String) —

    The unique string that we created to identify the Message resource.



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

def sid
    @properties['sid']
end

#to ⇒ String

Returns The SID of the [Channel](www.twilio.com/docs/chat/api/channels) that the message was sent to.

Returns:



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

def to
    @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



431
432
433
434
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 431

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

Parameters:

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

    The message to send to the channel. Can also be an empty string or ‘null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.

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

    A valid JSON string that contains application-specific data.

Returns:



418
419
420
421
422
423
424
425
426
427
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 418

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

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

#url ⇒ String

Returns The absolute URL of the Message resource.

Returns:

  • (String) —

    The absolute URL of the Message resource.



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

def url
    @properties['url']
end

#was_edited ⇒ Boolean

Returns Whether the message has been edited since it was created.

Returns:

  • (Boolean) —

    Whether the message has been edited since it was created.



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

def was_edited
    @properties['was_edited']
end