Class: Twilio::REST::Proxy::V1::ServiceContext::SessionContext::ParticipantContext::MessageInteractionInstance

Inherits:

InstanceResource

Object
InstanceResource
Twilio::REST::Proxy::V1::ServiceContext::SessionContext::ParticipantContext::MessageInteractionInstance

show all

Defined in:: lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

#account_sid ⇒ String

Account Sid.
#context ⇒ MessageInteractionContext

Generate an instance context for the instance, the context is capable of performing various actions.
#data ⇒ String

Message body.
#date_created ⇒ Time

The date this Message Interaction was created.
#date_updated ⇒ Time

The date this Message Interaction was last updated.
#fetch ⇒ MessageInteractionInstance

Fetch a MessageInteractionInstance.
#inbound_participant_sid ⇒ String

Always empty for Message Interactions.
#inbound_resource_sid ⇒ String

Always empty for Message Interactions.
#inbound_resource_status ⇒ message_interaction.ResourceStatus

Always empty for Message Interactions.
#inbound_resource_type ⇒ String

Always empty for Message Interactions.
#inbound_resource_url ⇒ String

Always empty for Message Interactions.
#initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil) ⇒ MessageInteractionInstance constructor

Initialize the MessageInteractionInstance.
#inspect ⇒ Object

Provide a detailed, user friendly representation.
#outbound_participant_sid ⇒ String

Outbound Participant Sid.
#outbound_resource_sid ⇒ String

Outbound message resource Sid.
#outbound_resource_status ⇒ message_interaction.ResourceStatus

The Outbound Resource Status of this Message Interaction.
#outbound_resource_type ⇒ String

Message.
#outbound_resource_url ⇒ String

The URL of the Twilio message resource.
#participant_sid ⇒ String

Participant Sid.
#service_sid ⇒ String

Service Sid.
#session_sid ⇒ String

Session Sid.
#sid ⇒ String

A string that uniquely identifies this Message Interaction.
#to_s ⇒ Object

Provide a user friendly representation.
#type ⇒ message_interaction.Type

The Type of this Message Interaction.
#url ⇒ String

The URL of this resource.

Constructor Details

#initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil) ⇒ `MessageInteractionInstance`

Initialize the MessageInteractionInstance

Parameters:

version (Version) —

Version that contains the resource
payload (Hash) —

payload that contains response from Twilio
service_sid (String) (defaults to: nil) —

The unique SID identifier of the parent [Service](www.twilio.com/docs/proxy/api/service).
session_sid (String) (defaults to: nil) —

The unique SID identifier of the parent [Session](www.twilio.com/docs/proxy/api/session).
participant_sid (String) (defaults to: nil) —

The unique SID identifier of the [Participant](www.twilio.com/docs/proxy/api/participants).
sid (String) (defaults to: nil) —

The sid

# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 256

def initialize(version, payload, service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'session_sid' => payload['session_sid'],
      'service_sid' => payload['service_sid'],
      'account_sid' => payload['account_sid'],
      'data' => payload['data'],
      'type' => payload['type'],
      'participant_sid' => payload['participant_sid'],
      'inbound_participant_sid' => payload['inbound_participant_sid'],
      'inbound_resource_sid' => payload['inbound_resource_sid'],
      'inbound_resource_status' => payload['inbound_resource_status'],
      'inbound_resource_type' => payload['inbound_resource_type'],
      'inbound_resource_url' => payload['inbound_resource_url'],
      'outbound_participant_sid' => payload['outbound_participant_sid'],
      'outbound_resource_sid' => payload['outbound_resource_sid'],
      'outbound_resource_status' => payload['outbound_resource_status'],
      'outbound_resource_type' => payload['outbound_resource_type'],
      'outbound_resource_url' => payload['outbound_resource_url'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ `String`

Returns Account Sid.

Returns:

(String) —

Account Sid.



330
331
332

# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 330

def account_sid
  @properties['account_sid']
end

#context ⇒ `MessageInteractionContext`

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

Returns:

(MessageInteractionContext) —

MessageInteractionContext for this MessageInteractionInstance

# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 297

def context
  unless @instance_context
    @instance_context = MessageInteractionContext.new(
        @version,
        @params['service_sid'],
        @params['session_sid'],
        @params['participant_sid'],
        @params['sid'],
    )
  end
  @instance_context
end

#data ⇒ `String`

Returns Message body.

Returns:

(String) —

Message body



336
337
338

# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 336

def data
  @properties['data']
end

#date_created ⇒ `Time`

Returns The date this Message Interaction was created.

Returns:

(Time) —

The date this Message Interaction was created



414
415
416

# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 414

def date_created
  @properties['date_created']
end

#date_updated ⇒ `Time`

Returns The date this Message Interaction was last updated.

Returns:

(Time) —

The date this Message Interaction was last updated



420
421
422

# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 420

def date_updated
  @properties['date_updated']
end

#fetch ⇒ `MessageInteractionInstance`

Fetch a MessageInteractionInstance

Returns:

(MessageInteractionInstance) —

Fetched MessageInteractionInstance



433
434
435

# File 'lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb', line 433

def fetch
  context.fetch
end