Class: Twilio::REST::Chat::V3::ChannelInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/chat/v3/channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ ChannelInstance

Initialize the ChannelInstance



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 293

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'friendly_name' => payload['friendly_name'],
        'unique_name' => payload['unique_name'],
        'attributes' => payload['attributes'],
        'type' => payload['type'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
        'members_count' => payload['members_count'] == nil ? payload['members_count'] : payload['members_count'].to_i,
        'messages_count' => payload['messages_count'] == nil ? payload['messages_count'] : payload['messages_count'].to_i,
        'messaging_service_sid' => payload['messaging_service_sid'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String 



339
340
341
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 339

def 
    @properties['account_sid']
end

#attributes ⇒ String 



363
364
365
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 363

def attributes
    @properties['attributes']
end

#context ⇒ ChannelContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 324

def context
    unless @instance_context
        @instance_context = ChannelContext.new(@version , @params['service_sid'], @params['sid'])
    end
    @instance_context
end

#created_by ⇒ String 



387
388
389
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 387

def created_by
    @properties['created_by']
end

#date_created ⇒ Time 



375
376
377
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 375

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



381
382
383
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 381

def date_updated
    @properties['date_updated']
end

#friendly_name ⇒ String 



351
352
353
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 351

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



443
444
445
446
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 443

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

#members_count ⇒ String 



393
394
395
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 393

def members_count
    @properties['members_count']
end

#messages_count ⇒ String 



399
400
401
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 399

def messages_count
    @properties['messages_count']
end

#messaging_service_sid ⇒ String 



405
406
407
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 405

def messaging_service_sid
    @properties['messaging_service_sid']
end

#service_sid ⇒ String 



345
346
347
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 345

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



333
334
335
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 333

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



436
437
438
439
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 436

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

#type ⇒ ChannelType 



369
370
371
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 369

def type
    @properties['type']
end

#unique_name ⇒ String 



357
358
359
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 357

def unique_name
    @properties['unique_name']
end

#update(type: :unset, messaging_service_sid: :unset, x_twilio_webhook_enabled: :unset) ⇒ ChannelInstance

Update the ChannelInstance



421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 421

def update(
    type: :unset, 
    messaging_service_sid: :unset, 
    x_twilio_webhook_enabled: :unset
)

    context.update(
        type: type, 
        messaging_service_sid: messaging_service_sid, 
        x_twilio_webhook_enabled: x_twilio_webhook_enabled, 
    )
end

#url ⇒ String 



411
412
413
 
# File 'lib/twilio-ruby/rest/chat/v3/channel.rb', line 411

def url
    @properties['url']
end