Class: Twilio::REST::Conversations::V1::ServiceContext::UserContext::UserConversationInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil, user_sid: nil, conversation_sid: nil) ⇒ UserConversationInstance

Initialize the UserConversationInstance



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 271

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 



314
315
316
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 314

def 
    @properties['account_sid']
end

#attributes ⇒ String 



374
375
376
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 374

def attributes
    @properties['attributes']
end

#chat_service_sid ⇒ String 



320
321
322
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 320

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



305
306
307
308
309
310
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 305

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 



326
327
328
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 326

def conversation_sid
    @properties['conversation_sid']
end

#conversation_state ⇒ State 



362
363
364
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 362

def conversation_state
    @properties['conversation_state']
end

#created_by ⇒ String 



392
393
394
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 392

def created_by
    @properties['created_by']
end

#date_created ⇒ Time 



380
381
382
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 380

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



386
387
388
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 386

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserConversationInstance



423
424
425
426
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 423

def delete

    context.delete
end

#fetch ⇒ UserConversationInstance

Fetch the UserConversationInstance



431
432
433
434
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 431

def fetch

    context.fetch
end

#friendly_name ⇒ String 



356
357
358
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 356

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



464
465
466
467
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 464

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

#last_read_message_index ⇒ String 



338
339
340
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 338

def last_read_message_index
    @properties['last_read_message_index']
end

#links ⇒ Hash 



416
417
418
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 416

def links
    @properties['links']
end

#notification_level ⇒ NotificationLevel 



398
399
400
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 398

def notification_level
    @properties['notification_level']
end

#participant_sid ⇒ String 



344
345
346
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 344

def participant_sid
    @properties['participant_sid']
end

#timers ⇒ Hash 



368
369
370
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 368

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



457
458
459
460
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 457

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

#unique_name ⇒ String 



404
405
406
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 404

def unique_name
    @properties['unique_name']
end

#unread_messages_count ⇒ String 



332
333
334
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 332

def unread_messages_count
    @properties['unread_messages_count']
end

#update(notification_level: :unset, last_read_timestamp: :unset, last_read_message_index: :unset) ⇒ UserConversationInstance

Update the UserConversationInstance



442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 442

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_timestamp, 
        last_read_message_index: last_read_message_index, 
    )
end

#url ⇒ String 



410
411
412
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 410

def url
    @properties['url']
end

#user_sid ⇒ String 



350
351
352
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 350

def user_sid
    @properties['user_sid']
end