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

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

    The SID of the Service the resource is associated with.

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

    The unique ID of the Channel the Message resource belongs to.

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

    The Twilio-provided string that uniquely identifies the Message resource to fetch.


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

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

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data.

Returns:

  • (String) —

    The JSON string that stores application-specific data


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

def attributes
  @properties['attributes']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message


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

def body
  @properties['body']
end

#channel_sid ⇒ String

Returns The unique ID of the Channel the Message resource belongs to.

Returns:

  • (String) —

    The unique ID of the Channel the Message resource belongs to


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

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:


313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 313

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 RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created


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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:


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

def fetch
  context.fetch
end

#from ⇒ String

Returns The identity of the message's author.

Returns:

  • (String) —

    The identity of the message's author


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

def from
  @properties['from']
end

#index ⇒ String

Returns The index of the message within the Channel.

Returns:

  • (String) —

    The index of the message within the Channel


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

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 that the resource is associated with.

Returns:

  • (String) —

    The SID of the Service that the resource is associated with


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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to ⇒ String

Returns The SID of the Channel that the message was sent to.

Returns:

  • (String) —

    The SID of the Channel that the message was sent to


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

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:


425
426
427
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel/message.rb', line 425

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


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

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


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

def was_edited
  @properties['was_edited']
end