Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::ParticipantInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ServiceContext::ConversationContext::ParticipantInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this participant.
-
#attributes ⇒ String
An optional string metadata field you can use to store any data you wish.
-
#chat_service_sid ⇒ String
The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Participant resource is associated with.
-
#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](www.twilio.com/docs/conversations/api/conversation-resource) for this participant.
-
#date_created ⇒ Time
The date on which this resource was created.
-
#date_updated ⇒ Time
The date on which this resource was last updated.
-
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ParticipantInstance.
-
#fetch ⇒ ParticipantInstance
Fetch the ParticipantInstance.
-
#identity ⇒ String
A unique string identifier for the conversation participant as [Conversation User](www.twilio.com/docs/conversations/api/user-resource).
-
#initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, sid: nil) ⇒ ParticipantInstance
constructor
Initialize the ParticipantInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#last_read_message_index ⇒ String
Index of last “read” message in the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.
-
#last_read_timestamp ⇒ String
Timestamp of last “read” message in the [Conversation](www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.
-
#messaging_binding ⇒ Hash
Information about how this participant exchanges messages with the conversation.
-
#role_sid ⇒ String
The SID of a conversation-level [Role](www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.
-
#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, 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.
-
#url ⇒ String
An absolute API resource URL for this participant.
Constructor Details
#initialize(version, payload, chat_service_sid: nil, conversation_sid: nil, sid: nil) ⇒ ParticipantInstance
Initialize the ParticipantInstance
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 344 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.
382 383 384 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 382 def account_sid @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.
412 413 414 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 412 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.
388 389 390 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 388 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
373 374 375 376 377 378 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 373 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.
394 395 396 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 394 def conversation_sid @properties['conversation_sid'] end |
#date_created ⇒ Time
Returns The date on which this resource was created.
430 431 432 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 430 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date on which this resource was last updated.
436 437 438 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 436 def date_updated @properties['date_updated'] end |
#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean
Delete the ParticipantInstance
462 463 464 465 466 467 468 469 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 462 def delete( x_twilio_webhook_enabled: :unset ) context.delete( x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#fetch ⇒ ParticipantInstance
Fetch the ParticipantInstance
474 475 476 477 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 474 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.
406 407 408 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 406 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
528 529 530 531 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 528 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.
448 449 450 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 448 def @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.
454 455 456 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 454 def @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.
418 419 420 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 418 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.
424 425 426 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 424 def role_sid @properties['role_sid'] end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
400 401 402 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 400 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
521 522 523 524 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 521 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
492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 492 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_timestamp: , x_twilio_webhook_enabled: x_twilio_webhook_enabled, ) end |
#url ⇒ String
Returns An absolute API resource URL for this participant.
442 443 444 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb', line 442 def url @properties['url'] end |