Class: Twilio::REST::Conversations::V1::ParticipantConversationInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ ParticipantConversationInstance

Initialize the ParticipantConversationInstance

Parameters:

  • Version that contains the resource

  • payload that contains response from Twilio

  • The SID of the Account that created this ParticipantConversation resource.

  • The SID of the Call resource to fetch.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 267

def initialize(version, payload )
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_sid'],
        'participant_sid' => payload['participant_sid'],
        'participant_user_sid' => payload['participant_user_sid'],
        'participant_identity' => payload['participant_identity'],
        'participant_messaging_binding' => payload['participant_messaging_binding'],
        'conversation_sid' => payload['conversation_sid'],
        'conversation_unique_name' => payload['conversation_unique_name'],
        'conversation_friendly_name' => payload['conversation_friendly_name'],
        'conversation_attributes' => payload['conversation_attributes'],
        'conversation_date_created' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_created']),
        'conversation_date_updated' => Twilio.deserialize_iso8601_datetime(payload['conversation_date_updated']),
        'conversation_created_by' => payload['conversation_created_by'],
        'conversation_state' => payload['conversation_state'],
        'conversation_timers' => payload['conversation_timers'],
        'links' => payload['links'],
    }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this conversation.

Returns:



295
296
297
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 295

def 
    @properties['account_sid']
end

#chat_service_sid ⇒ String

Returns The unique ID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.

Returns:



301
302
303
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 301

def chat_service_sid
    @properties['chat_service_sid']
end

#conversation_attributes ⇒ String

Returns An optional 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.

Returns:

  • An optional 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.



349
350
351
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 349

def conversation_attributes
    @properties['conversation_attributes']
end

#conversation_created_by ⇒ String

Returns Identity of the creator of this Conversation.

Returns:

  • Identity of the creator of this Conversation.



367
368
369
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 367

def conversation_created_by
    @properties['conversation_created_by']
end

#conversation_date_created ⇒ Time

Returns The date that this conversation was created, given in ISO 8601 format.

Returns:

  • The date that this conversation was created, given in ISO 8601 format.



355
356
357
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 355

def conversation_date_created
    @properties['conversation_date_created']
end

#conversation_date_updated ⇒ Time

Returns The date that this conversation was last updated, given in ISO 8601 format.

Returns:

  • The date that this conversation was last updated, given in ISO 8601 format.



361
362
363
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 361

def conversation_date_updated
    @properties['conversation_date_updated']
end

#conversation_friendly_name ⇒ String

Returns The human-readable name of this conversation, limited to 256 characters. Optional.

Returns:

  • The human-readable name of this conversation, limited to 256 characters. Optional.



343
344
345
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 343

def conversation_friendly_name
    @properties['conversation_friendly_name']
end

#conversation_sid ⇒ String

Returns The unique ID of the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) this Participant belongs to.

Returns:



331
332
333
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 331

def conversation_sid
    @properties['conversation_sid']
end

#conversation_state ⇒ State

Returns:



373
374
375
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 373

def conversation_state
    @properties['conversation_state']
end

#conversation_timers ⇒ Hash

Returns Timer date values representing state update for this conversation.

Returns:

  • Timer date values representing state update for this conversation.



379
380
381
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 379

def conversation_timers
    @properties['conversation_timers']
end

#conversation_unique_name ⇒ String

Returns An application-defined string that uniquely identifies the Conversation resource.

Returns:

  • An application-defined string that uniquely identifies the Conversation resource.



337
338
339
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 337

def conversation_unique_name
    @properties['conversation_unique_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



397
398
399
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 397

def inspect
    "<Twilio.Conversations.V1.ParticipantConversationInstance>"
end

#links ⇒ Hash

Returns Contains absolute URLs to access the [participant](www.twilio.com/docs/conversations/api/conversation-participant-resource) and [conversation](www.twilio.com/docs/conversations/api/conversation-resource) of this conversation.

Returns:



385
386
387
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 385

def links
    @properties['links']
end

#participant_identity ⇒ String

Returns A unique string identifier for the conversation participant as [Conversation User](www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.

Returns:

  • A unique string identifier for the conversation participant as [Conversation User](www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the Conversations SDK to communicate. Limited to 256 characters.



319
320
321
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 319

def participant_identity
    @properties['participant_identity']
end

#participant_messaging_binding ⇒ Hash

Returns Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.

Returns:

  • Information about how this participant exchanges messages with the conversation. A JSON parameter consisting of type and address fields of the participant.



325
326
327
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 325

def participant_messaging_binding
    @properties['participant_messaging_binding']
end

#participant_sid ⇒ String

Returns The unique ID of the [Participant](www.twilio.com/docs/conversations/api/conversation-participant-resource).

Returns:



307
308
309
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 307

def participant_sid
    @properties['participant_sid']
end

#participant_user_sid ⇒ String

Returns The unique string that identifies the conversation participant as [Conversation User](www.twilio.com/docs/conversations/api/user-resource).

Returns:



313
314
315
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 313

def participant_user_sid
    @properties['participant_user_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



391
392
393
 
# File 'lib/twilio-ruby/rest/conversations/v1/participant_conversation.rb', line 391

def to_s
    "<Twilio.Conversations.V1.ParticipantConversationInstance>"
end