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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the UserConversationInstance



267
268
269
270
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
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 267

def initialize(version, payload , 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 = { 'user_sid' => user_sid  || @properties['user_sid']  ,'conversation_sid' => conversation_sid  || @properties['conversation_sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



310
311
312
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 310

def 
    @properties['account_sid']
end

#attributes ⇒ String 



370
371
372
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 370

def attributes
    @properties['attributes']
end

#chat_service_sid ⇒ String 



316
317
318
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 316

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



301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 301

def context
    unless @instance_context
        @instance_context = UserConversationContext.new(@version , @params['user_sid'], @params['conversation_sid'])
    end
    @instance_context
end

#conversation_sid ⇒ String 



322
323
324
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 322

def conversation_sid
    @properties['conversation_sid']
end

#conversation_state ⇒ State 



358
359
360
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 358

def conversation_state
    @properties['conversation_state']
end

#created_by ⇒ String 



388
389
390
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 388

def created_by
    @properties['created_by']
end

#date_created ⇒ Time 



376
377
378
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 376

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



382
383
384
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 382

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserConversationInstance



419
420
421
422
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 419

def delete

    context.delete
end

#fetch ⇒ UserConversationInstance

Fetch the UserConversationInstance



427
428
429
430
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 427

def fetch

    context.fetch
end

#friendly_name ⇒ String 



352
353
354
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 352

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



460
461
462
463
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 460

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

#last_read_message_index ⇒ String 



334
335
336
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 334

def last_read_message_index
    @properties['last_read_message_index']
end

#links ⇒ Hash 



412
413
414
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 412

def links
    @properties['links']
end

#notification_level ⇒ NotificationLevel 



394
395
396
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 394

def notification_level
    @properties['notification_level']
end

#participant_sid ⇒ String 



340
341
342
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 340

def participant_sid
    @properties['participant_sid']
end

#timers ⇒ Hash 



364
365
366
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 364

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



453
454
455
456
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 453

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

#unique_name ⇒ String 



400
401
402
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 400

def unique_name
    @properties['unique_name']
end

#unread_messages_count ⇒ String 



328
329
330
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 328

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



438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 438

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 



406
407
408
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 406

def url
    @properties['url']
end

#user_sid ⇒ String 



346
347
348
 
# File 'lib/twilio-ruby/rest/conversations/v1/user/user_conversation.rb', line 346

def user_sid
    @properties['user_sid']
end