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.


314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 314

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.


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

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.


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

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.


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

def author
  @properties['author']
end

#bodyString

Returns The content of the message.

Returns:

  • (String)

    The content of the message.


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

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:


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

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.


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

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.


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

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.


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

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


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

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.


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

def delivery
  @properties['delivery']
end

#delivery_receiptsdelivery_receipts

Access the delivery_receipts

Returns:


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

def delivery_receipts
  context.delivery_receipts
end

#fetchMessageInstance

Fetch the MessageInstance

Returns:


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

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.


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

def index
  @properties['index']
end

#inspectObject

Provide a detailed, user friendly representation


493
494
495
496
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 493

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.


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

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.


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

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.


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

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.


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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:


450
451
452
453
454
455
456
457
458
459
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 450

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.


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

def url
  @properties['url']
end