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.



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 351

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'] == nil ? payload['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'],
      'content_sid' => payload['content_sid'],
  }

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

Instance Method Details

#account_sid ⇒ String

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

Returns:

  • (String) —

    The unique ID of the Account responsible for this message.



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

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.



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

def attributes
  @properties['attributes']
end

#author ⇒ String

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

Returns:

  • (String) —

    The channel specific identifier of the message’s author.



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

def author
  @properties['author']
end

#body ⇒ String

Returns The content of the message.

Returns:

  • (String) —

    The content of the message.



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

def body
  @properties['body']
end

#chat_service_sid ⇒ String

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.



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

def chat_service_sid
  @properties['chat_service_sid']
end

#content_sid ⇒ String

Returns The unique ID of the multi-channel Rich Content template.

Returns:

  • (String) —

    The unique ID of the multi-channel Rich Content template.



491
492
493
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 491

def content_sid
  @properties['content_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:



387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 387

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

#conversation_sid ⇒ String

Returns The unique ID of the Conversation for this message.

Returns:

  • (String) —

    The unique ID of the Conversation for this message.



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

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



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

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



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

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

#delivery ⇒ Hash

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.



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

def delivery
  @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts

Returns:



540
541
542
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 540

def delivery_receipts
  context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



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

def fetch
  context.fetch
end

#index ⇒ String

Returns The index of the message within the Conversation.

Returns:

  • (String) —

    The index of the message within the Conversation.



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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



553
554
555
556
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 553

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

#links ⇒ String

Returns Absolute URL to access the receipts of this message.

Returns:

  • (String) —

    Absolute URL to access the receipts of this message.



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

def links
  @properties['links']
end

#media ⇒ Array[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.



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

def media
  @properties['media']
end

#participant_sid ⇒ String

Returns The unique ID of messages’s author participant.

Returns:

  • (String) —

    The unique ID of messages’s author participant.



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

def participant_sid
  @properties['participant_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



546
547
548
549
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 546

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:



510
511
512
513
514
515
516
517
518
519
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb', line 510

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

#url ⇒ String

Returns An absolute URL for this message.

Returns:

  • (String) —

    An absolute URL for this message.



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

def url
  @properties['url']
end