Class: Twilio::REST::Conversations::V1::ConversationContext::ParticipantInstance

Inherits:

InstanceResource

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

Defined in:

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

Overview

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

Instance Method Summary

• #account_sid ⇒ String

  The unique id of the Account responsible for this participant.

• #attributes ⇒ String

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

• #context ⇒ ParticipantContext

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

• #date_created ⇒ Time

  The date that this resource was created.

• #date_updated ⇒ Time

  The date that this resource was last updated.

• #delete ⇒ Boolean

  Deletes the ParticipantInstance.

• #fetch ⇒ ParticipantInstance

  Fetch a ParticipantInstance.

• #identity ⇒ String

  A unique string identifier for the conversation participant as Chat User.

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

  Initialize the ParticipantInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #messaging_binding ⇒ Hash

  Information about how this participant exchanges messages with the conversation.

• #sid ⇒ String

  A 34 character string that uniquely identifies this resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(date_created: :unset, date_updated: :unset, attributes: :unset) ⇒ ParticipantInstance

  Update the ParticipantInstance.

• #url ⇒ String

  An absolute URL for this participant.

Constructor Details

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

Initialize the ParticipantInstance

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

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'],
      'identity' => payload['identity'],
      'attributes' => payload['attributes'],
      'messaging_binding' => payload['messaging_binding'],
      '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 = {'conversation_sid' => conversation_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#attributes ⇒ String

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

def attributes
  @properties['attributes']
end

#context ⇒ ParticipantContext

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/participant.rb', line 325

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

#conversation_sid ⇒ String

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

def conversation_sid
  @properties['conversation_sid']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ParticipantInstance

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

def delete
  context.delete
end

#fetch ⇒ ParticipantInstance

Fetch a ParticipantInstance

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

def fetch
  context.fetch
end

#identity ⇒ String

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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#messaging_binding ⇒ Hash

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

def messaging_binding
  @properties['messaging_binding']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#update(date_created: :unset, date_updated: :unset, attributes: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance

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

def update(date_created: :unset, date_updated: :unset, attributes: :unset)
  context.update(date_created: date_created, date_updated: date_updated, attributes: attributes, )
end

#url ⇒ String

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

def url
  @properties['url']
end