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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 258

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 



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

def 
    @properties['account_sid']
end

#attributes ⇒ String 



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

def attributes
    @properties['attributes']
end

#chat_service_sid ⇒ String 



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

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



292
293
294
295
296
297
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 292

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 



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

def conversation_sid
    @properties['conversation_sid']
end

#conversation_state ⇒ State 



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

def conversation_state
    @properties['conversation_state']
end

#created_by ⇒ String 



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

def created_by
    @properties['created_by']
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the UserConversationInstance



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

def delete

    context.delete
end

#fetch ⇒ UserConversationInstance

Fetch the UserConversationInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



451
452
453
454
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 451

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

#last_read_message_index ⇒ String 



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

def last_read_message_index
    @properties['last_read_message_index']
end

#links ⇒ Hash 



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

def links
    @properties['links']
end

#notification_level ⇒ NotificationLevel 



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

def notification_level
    @properties['notification_level']
end

#participant_sid ⇒ String 



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

def participant_sid
    @properties['participant_sid']
end

#timers ⇒ Hash 



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

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



444
445
446
447
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 444

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

#unique_name ⇒ String 



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

def unique_name
    @properties['unique_name']
end

#unread_messages_count ⇒ String 



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

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



429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb', line 429

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 



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

def url
    @properties['url']
end

#user_sid ⇒ String 



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

def user_sid
    @properties['user_sid']
end