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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ParticipantInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Participant resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 326

def initialize(version, payload , chat_service_sid: nil, conversation_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_sid'],
        'conversation_sid' => payload['conversation_sid'],
        'sid' => payload['sid'],
        'identity' => payload['identity'],
        'attributes' => payload['attributes'],
        'messaging_binding' => payload['messaging_binding'],
        'role_sid' => payload['role_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'last_read_message_index' => payload['last_read_message_index'] == nil ? payload['last_read_message_index'] : payload['last_read_message_index'].to_i,
        'last_read_timestamp' => payload['last_read_timestamp'],
    }

    # Context
    @instance_context = nil
    @params = { 'chat_service_sid' => chat_service_sid  || @properties['chat_service_sid']  ,'conversation_sid' => conversation_sid  || @properties['conversation_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



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

def 
    @properties['account_sid']
end

#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:

  • (String) —

    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.



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

def attributes
    @properties['attributes']
end

#chat_service_sid ⇒ String

Returns The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.

Returns:



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

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

Returns:



355
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 355

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

#conversation_sid ⇒ String

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

Returns:



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

def conversation_sid
    @properties['conversation_sid']
end

#date_created ⇒ Time

Returns The date on which this resource was created.

Returns:

  • (Time) —

    The date on which this resource was created.



412
413
414
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 412

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date on which this resource was last updated.

Returns:

  • (Time) —

    The date on which this resource was last updated.



418
419
420
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 418

def date_updated
    @properties['date_updated']
end

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ParticipantInstance

Parameters:

  • x_twilio_webhook_enabled (ServiceConversationParticipantEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



444
445
446
447
448
449
450
451
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 444

def delete(
    x_twilio_webhook_enabled: :unset
)

    context.delete(
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#fetch ⇒ ParticipantInstance

Fetch the ParticipantInstance

Returns:



456
457
458
459
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 456

def fetch

    context.fetch
end

#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 [Conversation SDK](www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.

Returns:



388
389
390
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 388

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



510
511
512
513
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 510

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

#last_read_message_index ⇒ String

Returns Index of last “read” message in the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.

Returns:



430
431
432
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 430

def last_read_message_index
    @properties['last_read_message_index']
end

#last_read_timestamp ⇒ String

Returns Timestamp of last “read” message in the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.

Returns:



436
437
438
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 436

def last_read_timestamp
    @properties['last_read_timestamp']
end

#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:

  • (Hash) —

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



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

def messaging_binding
    @properties['messaging_binding']
end

#role_sid ⇒ String

Returns The SID of a conversation-level [Role](www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.

Returns:



406
407
408
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 406

def role_sid
    @properties['role_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



503
504
505
506
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 503

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

#update(date_created: :unset, date_updated: :unset, identity: :unset, attributes: :unset, role_sid: :unset, messaging_binding_proxy_address: :unset, messaging_binding_projected_address: :unset, last_read_message_index: :unset, last_read_timestamp: :unset, x_twilio_webhook_enabled: :unset) ⇒ ParticipantInstance

Update the ParticipantInstance

Parameters:

  • date_created (Time) (defaults to: :unset) —

    The date on which this resource was created.

  • date_updated (Time) (defaults to: :unset) —

    The date on which this resource was last updated.

  • identity (String) (defaults to: :unset) —

    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 [Conversation SDK](www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.

  • attributes (String) (defaults to: :unset) —

    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.

  • role_sid (String) (defaults to: :unset) —

    The SID of a conversation-level [Role](www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.

  • messaging_binding_proxy_address (String) (defaults to: :unset) —

    The address of the Twilio phone number that the participant is in contact with. ‘null’ value will remove it.

  • messaging_binding_projected_address (String) (defaults to: :unset) —

    The address of the Twilio phone number that is used in Group MMS. ‘null’ value will remove it.

  • last_read_message_index (String) (defaults to: :unset) —

    Index of last “read” message in the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.

  • last_read_timestamp (String) (defaults to: :unset) —

    Timestamp of last “read” message in the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.

  • x_twilio_webhook_enabled (ServiceConversationParticipantEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 474

def update(
    date_created: :unset, 
    date_updated: :unset, 
    identity: :unset, 
    attributes: :unset, 
    role_sid: :unset, 
    messaging_binding_proxy_address: :unset, 
    messaging_binding_projected_address: :unset, 
    last_read_message_index: :unset, 
    last_read_timestamp: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        date_created: date_created, 
        date_updated: date_updated, 
        identity: identity, 
        attributes: attributes, 
        role_sid: role_sid, 
        messaging_binding_proxy_address: messaging_binding_proxy_address, 
        messaging_binding_projected_address: messaging_binding_projected_address, 
        last_read_message_index: last_read_message_index, 
        last_read_timestamp: last_read_timestamp, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String

Returns An absolute API resource URL for this participant.

Returns:

  • (String) —

    An absolute API resource URL for this participant.



424
425
426
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 424

def url
    @properties['url']
end