Class: Twilio::REST::Chat::V2::ServiceContext::ChannelInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the ChannelInstance



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 331

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'].to_i,
      'messages_count' => payload['messages_count'].to_i,
      'url' => payload['url'],
      'links' => payload['links'],
  }

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

Instance Method Details

#account_sid ⇒ String 



376
377
378
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 376

def 
  @properties['account_sid']
end

#attributes ⇒ String 



400
401
402
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 400

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



361
362
363
364
365
366
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 361

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

#created_by ⇒ String 



424
425
426
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 424

def created_by
  @properties['created_by']
end

#date_created ⇒ Time 



412
413
414
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 412

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



418
419
420
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 418

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ChannelInstance



462
463
464
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 462

def delete
  context.delete
end

#fetch ⇒ ChannelInstance

Fetch a ChannelInstance



455
456
457
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 455

def fetch
  context.fetch
end

#friendly_name ⇒ String 



388
389
390
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 388

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



516
517
518
519
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 516

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

#invites ⇒ invites

Access the invites



503
504
505
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 503

def invites
  context.invites
end

#links ⇒ String 



448
449
450
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 448

def links
  @properties['links']
end

#members ⇒ members

Access the members



489
490
491
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 489

def members
  context.members
end

#members_count ⇒ String 



430
431
432
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 430

def members_count
  @properties['members_count']
end

#messages ⇒ messages

Access the messages



496
497
498
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 496

def messages
  context.messages
end

#messages_count ⇒ String 



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

def messages_count
  @properties['messages_count']
end

#service_sid ⇒ String 



382
383
384
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 382

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



370
371
372
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 370

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



509
510
511
512
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 509

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

#type ⇒ channel.ChannelType 



406
407
408
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 406

def type
  @properties['type']
end

#unique_name ⇒ String 



394
395
396
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 394

def unique_name
  @properties['unique_name']
end

#update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset) ⇒ ChannelInstance

Update the ChannelInstance



475
476
477
478
479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 475

def update(friendly_name: :unset, unique_name: :unset, attributes: :unset, date_created: :unset, date_updated: :unset, created_by: :unset)
  context.update(
      friendly_name: friendly_name,
      unique_name: unique_name,
      attributes: attributes,
      date_created: date_created,
      date_updated: date_updated,
      created_by: created_by,
  )
end

#url ⇒ String 



442
443
444
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 442

def url
  @properties['url']
end