Class: Twilio::REST::Chat::V1::ServiceContext::ChannelInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the ChannelInstance



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

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 



378
379
380
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 378

def 
  @properties['account_sid']
end

#attributes ⇒ String 



402
403
404
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 402

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



363
364
365
366
367
368
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 363

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

#created_by ⇒ String 



426
427
428
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 426

def created_by
  @properties['created_by']
end

#date_created ⇒ Time 



414
415
416
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 414

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time 



420
421
422
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 420

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ChannelInstance



464
465
466
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 464

def delete
  context.delete
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance



457
458
459
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 457

def fetch
  context.fetch
end

#friendly_name ⇒ String 



390
391
392
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 390

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



513
514
515
516
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 513

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

#invites ⇒ invites

Access the invites



500
501
502
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 500

def invites
  context.invites
end

#links ⇒ String 



450
451
452
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 450

def links
  @properties['links']
end

#members ⇒ members

Access the members



486
487
488
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 486

def members
  context.members
end

#members_count ⇒ String 



432
433
434
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 432

def members_count
  @properties['members_count']
end

#messages ⇒ messages

Access the messages



493
494
495
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 493

def messages
  context.messages
end

#messages_count ⇒ String 



438
439
440
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 438

def messages_count
  @properties['messages_count']
end

#service_sid ⇒ String 



384
385
386
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 384

def service_sid
  @properties['service_sid']
end

#sid ⇒ String 



372
373
374
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 372

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



506
507
508
509
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 506

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

#type ⇒ channel.ChannelType 



408
409
410
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 408

def type
  @properties['type']
end

#unique_name ⇒ String 



396
397
398
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 396

def unique_name
  @properties['unique_name']
end

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

Update the ChannelInstance



479
480
481
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 479

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

#url ⇒ String 



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

def url
  @properties['url']
end