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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil, 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

  • chat_service_sid (String) (defaults to: nil)

    The SID of the Conversation Service the Participant resource is associated with.

  • 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.


336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 336

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'chat_service_sid' => payload['chat_service_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']),
      'delivery' => payload['delivery'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {
      'chat_service_sid' => chat_service_sid,
      '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.


385
386
387
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 385

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.


433
434
435
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 433

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.


415
416
417
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 415

def author
  @properties['author']
end

#bodyString

Returns The content of the message.

Returns:

  • (String)

    The content of the message.


421
422
423
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 421

def body
  @properties['body']
end

#chat_service_sidString

Returns The SID of the Conversation Service that the resource is associated with.

Returns:

  • (String)

    The SID of the Conversation Service that the resource is associated with.


391
392
393
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 391

def chat_service_sid
  @properties['chat_service_sid']
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:


371
372
373
374
375
376
377
378
379
380
381
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 371

def context
  unless @instance_context
    @instance_context = MessageContext.new(
        @version,
        @params['chat_service_sid'],
        @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.


397
398
399
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 397

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.


445
446
447
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 445

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.


451
452
453
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 451

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


504
505
506
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 504

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.


457
458
459
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 457

def delivery
  @properties['delivery']
end

#delivery_receiptsdelivery_receipts

Access the delivery_receipts

Returns:


518
519
520
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 518

def delivery_receipts
  context.delivery_receipts
end

#fetchMessageInstance

Fetch the MessageInstance

Returns:


511
512
513
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 511

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.


409
410
411
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 409

def index
  @properties['index']
end

#inspectObject

Provide a detailed, user friendly representation


531
532
533
534
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 531

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.


469
470
471
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 469

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.


427
428
429
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 427

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.


439
440
441
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 439

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.


403
404
405
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 403

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


524
525
526
527
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 524

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:


488
489
490
491
492
493
494
495
496
497
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 488

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 URL for this message.

Returns:

  • (String)

    An absolute URL for this message.


463
464
465
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 463

def url
  @properties['url']
end