Class: Twilio::REST::Conversations::V1::ServiceContext::UserContext::UserConversationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ServiceContext::UserContext::UserConversationInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this conversation.
-
#attributes ⇒ String
An optional string metadata field you can use to store any data you wish.
-
#chat_service_sid ⇒ String
The unique ID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.
-
#context ⇒ UserConversationContext
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 User Conversation.
- #conversation_state ⇒ State
-
#created_by ⇒ String
Identity of the creator of this Conversation.
-
#date_created ⇒ Time
The date that this conversation was created, given in ISO 8601 format.
-
#date_updated ⇒ Time
The date that this conversation was last updated, given in ISO 8601 format.
-
#delete ⇒ Boolean
Delete the UserConversationInstance.
-
#fetch ⇒ UserConversationInstance
Fetch the UserConversationInstance.
-
#friendly_name ⇒ String
The human-readable name of this conversation, limited to 256 characters.
-
#initialize(version, payload, chat_service_sid: nil, user_sid: nil, conversation_sid: nil) ⇒ UserConversationInstance
constructor
Initialize the UserConversationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#last_read_message_index ⇒ String
The index of the last Message in the Conversation that the Participant has read.
-
#links ⇒ Hash
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.
- #notification_level ⇒ NotificationLevel
-
#participant_sid ⇒ String
The unique ID of the [participant](www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to.
-
#timers ⇒ Hash
Timer date values representing state update for this conversation.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the Conversation resource.
-
#unread_messages_count ⇒ String
The number of unread Messages in the Conversation for the Participant.
-
#update(notification_level: :unset, last_read_timestamp: :unset, last_read_message_index: :unset) ⇒ UserConversationInstance
Update the UserConversationInstance.
- #url ⇒ String
-
#user_sid ⇒ String
The unique string that identifies the [User resource](www.twilio.com/docs/conversations/api/user-resource).
Constructor Details
#initialize(version, payload, chat_service_sid: nil, user_sid: nil, conversation_sid: nil) ⇒ UserConversationInstance
Initialize the UserConversationInstance
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 252 def initialize(version, payload , chat_service_sid: nil, user_sid: nil, conversation_sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'chat_service_sid' => payload['chat_service_sid'], 'conversation_sid' => payload['conversation_sid'], 'unread_messages_count' => payload['unread_messages_count'] == nil ? payload['unread_messages_count'] : payload['unread_messages_count'].to_i, 'last_read_message_index' => payload['last_read_message_index'] == nil ? payload['last_read_message_index'] : payload['last_read_message_index'].to_i, 'participant_sid' => payload['participant_sid'], 'user_sid' => payload['user_sid'], 'friendly_name' => payload['friendly_name'], 'conversation_state' => payload['conversation_state'], 'timers' => payload['timers'], 'attributes' => payload['attributes'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'created_by' => payload['created_by'], 'notification_level' => payload['notification_level'], 'unique_name' => payload['unique_name'], 'url' => payload['url'], 'links' => payload['links'], } # Context @instance_context = nil @params = { 'chat_service_sid' => chat_service_sid || @properties['chat_service_sid'] ,'user_sid' => user_sid || @properties['user_sid'] ,'conversation_sid' => conversation_sid || @properties['conversation_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 conversation.
295 296 297 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 295 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.
355 356 357 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 355 def attributes @properties['attributes'] 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.
301 302 303 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 301 def chat_service_sid @properties['chat_service_sid'] end |
#context ⇒ UserConversationContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
286 287 288 289 290 291 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 286 def context unless @instance_context @instance_context = UserConversationContext.new(@version , @params['chat_service_sid'], @params['user_sid'], @params['conversation_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 User Conversation.
307 308 309 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 307 def conversation_sid @properties['conversation_sid'] end |
#conversation_state ⇒ State
343 344 345 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 343 def conversation_state @properties['conversation_state'] end |
#created_by ⇒ String
Returns Identity of the creator of this Conversation.
373 374 375 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 373 def created_by @properties['created_by'] end |
#date_created ⇒ Time
Returns The date that this conversation was created, given in ISO 8601 format.
361 362 363 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 361 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this conversation was last updated, given in ISO 8601 format.
367 368 369 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 367 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the UserConversationInstance
404 405 406 407 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 404 def delete context.delete end |
#fetch ⇒ UserConversationInstance
Fetch the UserConversationInstance
412 413 414 415 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 412 def fetch context.fetch end |
#friendly_name ⇒ String
Returns The human-readable name of this conversation, limited to 256 characters. Optional.
337 338 339 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 337 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
445 446 447 448 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 445 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.UserConversationInstance #{values}>" end |
#last_read_message_index ⇒ String
Returns The index of the last Message in the Conversation that the Participant has read.
319 320 321 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 319 def @properties['last_read_message_index'] 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.
397 398 399 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 397 def links @properties['links'] end |
#notification_level ⇒ NotificationLevel
379 380 381 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 379 def notification_level @properties['notification_level'] end |
#participant_sid ⇒ String
Returns The unique ID of the [participant](www.twilio.com/docs/conversations/api/conversation-participant-resource) the user conversation belongs to.
325 326 327 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 325 def participant_sid @properties['participant_sid'] end |
#timers ⇒ Hash
Returns Timer date values representing state update for this conversation.
349 350 351 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 349 def timers @properties['timers'] end |
#to_s ⇒ Object
Provide a user friendly representation
438 439 440 441 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 438 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.UserConversationInstance #{values}>" end |
#unique_name ⇒ String
Returns An application-defined string that uniquely identifies the Conversation resource. It can be used to address the resource in place of the resource’s ‘conversation_sid` in the URL.
385 386 387 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 385 def unique_name @properties['unique_name'] end |
#unread_messages_count ⇒ String
Returns The number of unread Messages in the Conversation for the Participant.
313 314 315 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 313 def @properties['unread_messages_count'] end |
#update(notification_level: :unset, last_read_timestamp: :unset, last_read_message_index: :unset) ⇒ UserConversationInstance
Update the UserConversationInstance
423 424 425 426 427 428 429 430 431 432 433 434 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 423 def update( notification_level: :unset, last_read_timestamp: :unset, last_read_message_index: :unset ) context.update( notification_level: notification_level, last_read_timestamp: , last_read_message_index: , ) end |
#url ⇒ String
391 392 393 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 391 def url @properties['url'] end |
#user_sid ⇒ String
Returns The unique string that identifies the [User resource](www.twilio.com/docs/conversations/api/user-resource).
331 332 333 |
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 331 def user_sid @properties['user_sid'] end |