Class: Twilio::REST::Conversations::V1::ConversationContext::MessageInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/conversation/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, conversation_sid: nil, sid: nil) ⇒ MessageInstance

Initialize the MessageInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • conversation_sid (String) (defaults to: nil)

    The unique ID of the Conversation for this message.

  • sid (String) (defaults to: nil)

    A 34 character string that uniquely identifies this resource.


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 307

def initialize(version, payload, conversation_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'conversation_sid' => payload['conversation_sid'],
      'sid' => payload['sid'],
      'index' => payload['index'].to_i,
      'author' => payload['author'],
      'body' => payload['body'],
      'media' => payload['media'],
      'attributes' => payload['attributes'],
      'participant_sid' => payload['participant_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'delivery' => payload['delivery'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sidString

Returns The unique ID of the Account responsible for this message.

Returns:

  • (String)

    The unique ID of the Account responsible for this message.


346
347
348
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 346

def 
  @properties['account_sid']
end

#attributesString

Returns A string metadata field you can use to store any data you wish.

Returns:

  • (String)

    A string metadata field you can use to store any data you wish.


388
389
390
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 388

def attributes
  @properties['attributes']
end

#authorString

Returns The channel specific identifier of the message's author.

Returns:

  • (String)

    The channel specific identifier of the message's author.


370
371
372
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 370

def author
  @properties['author']
end

#bodyString

Returns The content of the message.

Returns:

  • (String)

    The content of the message.


376
377
378
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 376

def body
  @properties['body']
end

#contextMessageContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:


337
338
339
340
341
342
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 337

def context
  unless @instance_context
    @instance_context = MessageContext.new(@version, @params['conversation_sid'], @params['sid'], )
  end
  @instance_context
end

#conversation_sidString

Returns The unique ID of the Conversation for this message.

Returns:

  • (String)

    The unique ID of the Conversation for this message.


352
353
354
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 352

def conversation_sid
  @properties['conversation_sid']
end

#date_createdTime

Returns The date that this resource was created.

Returns:

  • (Time)

    The date that this resource was created.


400
401
402
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 400

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date that this resource was last updated.

Returns:

  • (Time)

    The date that this resource was last updated.


406
407
408
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 406

def date_updated
  @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance

Parameters:

  • x_twilio_webhook_enabled (message.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


459
460
461
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 459

def delete(x_twilio_webhook_enabled: :unset)
  context.delete(x_twilio_webhook_enabled: x_twilio_webhook_enabled, )
end

#deliveryHash

Returns An object that contains the summary of delivery statuses for the message to non-chat participants.

Returns:

  • (Hash)

    An object that contains the summary of delivery statuses for the message to non-chat participants.


418
419
420
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 418

def delivery
  @properties['delivery']
end

#delivery_receiptsdelivery_receipts

Access the delivery_receipts

Returns:


473
474
475
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 473

def delivery_receipts
  context.delivery_receipts
end

#fetchMessageInstance

Fetch the MessageInstance

Returns:


466
467
468
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 466

def fetch
  context.fetch
end

#indexString

Returns The index of the message within the Conversation.

Returns:

  • (String)

    The index of the message within the Conversation.


364
365
366
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 364

def index
  @properties['index']
end

#inspectObject

Provide a detailed, user friendly representation


486
487
488
489
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 486

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

Returns Absolute URL to access the receipts of this message.

Returns:

  • (String)

    Absolute URL to access the receipts of this message.


424
425
426
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 424

def links
  @properties['links']
end

#mediaArray[Hash]

Returns An array of objects that describe the Message's media if attached, otherwise, null.

Returns:

  • (Array[Hash])

    An array of objects that describe the Message's media if attached, otherwise, null.


382
383
384
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 382

def media
  @properties['media']
end

#participant_sidString

Returns The unique ID of messages's author participant.

Returns:

  • (String)

    The unique ID of messages's author participant.


394
395
396
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 394

def participant_sid
  @properties['participant_sid']
end

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.


358
359
360
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 358

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


479
480
481
482
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 479

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

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

Update the MessageInstance

Parameters:

  • author (String) (defaults to: :unset)

    The channel specific identifier of the message's author. Defaults to `system`.

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

    The content of the message, can be up to 1,600 characters long.

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

    The date that this resource was created.

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

    The date that this resource was last updated. `null` if the message has not been edited.

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

    A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set “{}” will be returned.

  • x_twilio_webhook_enabled (message.WebhookEnabledType) (defaults to: :unset)

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:


443
444
445
446
447
448
449
450
451
452
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 443

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

#urlString

Returns An absolute API URL for this message.

Returns:

  • (String)

    An absolute API URL for this message.


412
413
414
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 412

def url
  @properties['url']
end