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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Conversations::V1::ConversationContext::MessageInstance

Defined in:

lib/twilio-ruby/rest/conversations/v1/conversation/message.rb

Instance Method Summary

• #account_sid ⇒ String

  The unique ID of the Account responsible for this message.

• #attributes ⇒ String

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

• #author ⇒ String

  The channel specific identifier of the message’s author.

• #body ⇒ String

  The content of the message.

• #context ⇒ MessageContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #conversation_sid ⇒ String

  The unique ID of the Conversation for this message.

• #date_created ⇒ Time

  The date that this resource was created.

• #date_updated ⇒ Time

  The date that this resource was last updated.

• #delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

  Delete the MessageInstance.

• #delivery ⇒ Hash

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

• #delivery_receipts ⇒ delivery_receipts

  Access the delivery_receipts.

• #fetch ⇒ MessageInstance

  Fetch the MessageInstance.

• #index ⇒ String

  The index of the message within the Conversation.

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

  Initialize the MessageInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  Absolute URL to access the receipts of this message.

• #media ⇒ Array[Hash]

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

• #participant_sid ⇒ String

  The unique ID of messages’s author participant.

• #sid ⇒ String

  A 34 character string that uniquely identifies this resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

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

  Update the MessageInstance.

• #url ⇒ String

  An absolute API URL for this message.

Constructor Details

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

Initialize the MessageInstance

# 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_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#attributes ⇒ String

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

def attributes
  @properties['attributes']
end

#author ⇒ String

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

def author
  @properties['author']
end

#body ⇒ String

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

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

# 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_sid ⇒ String

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

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# 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

# 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

#delivery ⇒ Hash

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

def delivery
  @properties['delivery']
end

#delivery_receipts ⇒ delivery_receipts

Access the delivery_receipts

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

def delivery_receipts
  context.delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

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

def fetch
  context.fetch
end

#index ⇒ String

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

def index
  @properties['index']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# 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

#links ⇒ String

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

def links
  @properties['links']
end

#media ⇒ Array[Hash]

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

def media
  @properties['media']
end

#participant_sid ⇒ String

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

def participant_sid
  @properties['participant_sid']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

# 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

# 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

#url ⇒ String

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

def url
  @properties['url']
end