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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil) —

    The service_sid

  • sid (String) (defaults to: nil) —

    The sid



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 366

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

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns The attributes.

Returns:

  • (String) —

    The attributes



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

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

Returns:



399
400
401
402
403
404
405
406
407
408
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 399

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

#created_by ⇒ String

Returns The created_by.

Returns:

  • (String) —

    The created_by



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

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



460
461
462
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 460

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ChannelInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ChannelInstance

Fetch a ChannelInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



552
553
554
555
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 552

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

#invites ⇒ invites

Access the invites

Returns:



539
540
541
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 539

def invites
  context.invites
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#members ⇒ members

Access the members

Returns:



525
526
527
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 525

def members
  context.members
end

#members_count ⇒ String

Returns The members_count.

Returns:

  • (String) —

    The members_count



472
473
474
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 472

def members_count
  @properties['members_count']
end

#messages ⇒ messages

Access the messages

Returns:



532
533
534
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 532

def messages
  context.messages
end

#messages_count ⇒ String

Returns The messages_count.

Returns:

  • (String) —

    The messages_count



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

def messages_count
  @properties['messages_count']
end

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



545
546
547
548
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 545

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

#type ⇒ channel.ChannelType

Returns The type.

Returns:

  • (channel.ChannelType) —

    The type



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

def type
  @properties['type']
end

#unique_name ⇒ String

Returns The unique_name.

Returns:

  • (String) —

    The unique_name



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

def unique_name
  @properties['unique_name']
end

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

Update the ChannelInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • unique_name (String) (defaults to: :unset) —

    The unique_name

  • attributes (String) (defaults to: :unset) —

    The attributes

Returns:



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

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

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end