class Twilio::REST::Conversations::V1::ServiceContext::ParticipantConversationInstance

Public Class Methods

new(version, payload, chat_service_sid: nil) click to toggle source

Initialize the ParticipantConversationInstance @param [Version] version Version that contains the resource @param [Hash] payload payload that contains response from Twilio @param [String] chat_service_sid The unique ID of the {Conversation

Service}[https://www.twilio.com/docs/conversations/api/service-resource] this
conversation belongs to.

@return [ParticipantConversationInstance] ParticipantConversationInstance

Calls superclass method Twilio::REST::InstanceResource::new
    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
188 def initialize(version, payload, chat_service_sid: nil)
189   super(version)
190 
191   # Marshaled Properties
192   @properties = {
193       'account_sid' => payload['account_sid'],
194       'chat_service_sid' => payload['chat_service_sid'],
195       'participant_sid' => payload['participant_sid'],
196       'participant_user_sid' => payload['participant_user_sid'],
197       'participant_identity' => payload['participant_identity'],
198       'participant_messaging_binding' => payload['participant_messaging_binding'],
199       'conversation_sid' => payload['conversation_sid'],
200       'conversation_unique_name' => payload['conversation_unique_name'],
201       'conversation_friendly_name' => payload['conversation_friendly_name'],
202       'conversation_attributes' => payload['conversation_attributes'],
203       'conversation_date_created' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_created']),
204       'conversation_date_updated' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_updated']),
205       'conversation_created_by' => payload['conversation_created_by'],
206       'conversation_state' => payload['conversation_state'],
207       'conversation_timers' => payload['conversation_timers'],
208       'links' => payload['links'],
209   }
210 end

Public Instance Methods

account_sid() click to toggle source

@return [String] The unique ID of the Account responsible for this conversation.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
214 def account_sid
215   @properties['account_sid']
216 end
chat_service_sid() click to toggle source

@return [String] The unique ID of the Conversation Service this conversation belongs to.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
220 def chat_service_sid
221   @properties['chat_service_sid']
222 end
conversation_attributes() click to toggle source

@return [String] An optional string metadata field you can use to store any data you wish.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
268 def conversation_attributes
269   @properties['conversation_attributes']
270 end
conversation_created_by() click to toggle source

@return [String] Creator of this conversation.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
286 def conversation_created_by
287   @properties['conversation_created_by']
288 end
conversation_date_created() click to toggle source

@return [Time] The date that this conversation was created.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
274 def conversation_date_created
275   @properties['conversation_date_created']
276 end
conversation_date_updated() click to toggle source

@return [Time] The date that this conversation was last updated.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
280 def conversation_date_updated
281   @properties['conversation_date_updated']
282 end
conversation_friendly_name() click to toggle source

@return [String] The human-readable name of this conversation.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
262 def conversation_friendly_name
263   @properties['conversation_friendly_name']
264 end
conversation_sid() click to toggle source

@return [String] The unique ID of the Conversation this Participant belongs to.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
250 def conversation_sid
251   @properties['conversation_sid']
252 end
conversation_state() click to toggle source

@return [participant_conversation.State] The current state of this User Conversation

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
292 def conversation_state
293   @properties['conversation_state']
294 end
conversation_timers() click to toggle source

@return [Hash] Timer date values for this conversation.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
298 def conversation_timers
299   @properties['conversation_timers']
300 end
conversation_unique_name() click to toggle source

@return [String] An application-defined string that uniquely identifies the Conversation resource.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
256 def conversation_unique_name
257   @properties['conversation_unique_name']
258 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
316 def inspect
317   "<Twilio.Conversations.V1.ParticipantConversationInstance>"
318 end
participant_identity() click to toggle source

@return [String] A unique string identifier for the conversation participant as Conversation User.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
238 def participant_identity
239   @properties['participant_identity']
240 end
participant_messaging_binding() click to toggle source

@return [Hash] Information about how this participant exchanges messages with the conversation.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
244 def participant_messaging_binding
245   @properties['participant_messaging_binding']
246 end
participant_sid() click to toggle source

@return [String] The unique ID of the Participant.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
226 def participant_sid
227   @properties['participant_sid']
228 end
participant_user_sid() click to toggle source

@return [String] The unique ID for the conversation participant as Conversation User.

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
232 def participant_user_sid
233   @properties['participant_user_sid']
234 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb
310 def to_s
311   "<Twilio.Conversations.V1.ParticipantConversationInstance>"
312 end