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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique id of the [Service](www.twilio.com/docs/chat/api/services) this channel belongs to.

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

    Key that uniquely defines the channel to fetch. Could be Sid or UniqueName.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 383

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 unique id of the Account responsible for this channel.

Returns:

  • (String) —

    The unique id of the Account responsible for this channel.



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

def 
  @properties['account_sid']
end

#attributes ⇒ String

Returns An optional string metadata field you can use to store any data you wish.

Returns:

  • (String) —

    An optional string metadata field you can use to store any data you wish.



452
453
454
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 452

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:



413
414
415
416
417
418
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 413

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

#created_by ⇒ String

Returns Identity of the channel’s creator.

Returns:

  • (String) —

    Identity of the channel’s creator.



476
477
478
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 476

def created_by
  @properties['created_by']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



470
471
472
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 470

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ChannelInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ChannelInstance

Fetch a ChannelInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The human-readable name of this channel.

Returns:

  • (String) —

    The human-readable name of this channel.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



580
581
582
583
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 580

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

#invites ⇒ invites

Access the invites

Returns:



560
561
562
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 560

def invites
  context.invites
end

#links ⇒ String

Returns Absolute URLs to access the Members, Messages , Invites and, if it exists the last Message for this Channel.

Returns:

  • (String) —

    Absolute URLs to access the Members, Messages , Invites and, if it exists the last Message for this Channel.



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

def links
  @properties['links']
end

#members ⇒ members

Access the members

Returns:



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

def members
  context.members
end

#members_count ⇒ String

Returns The number of Members in the Channel.

Returns:

  • (String) —

    The number of Members in the Channel



482
483
484
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 482

def members_count
  @properties['members_count']
end

#messages ⇒ messages

Access the messages

Returns:



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

def messages
  context.messages
end

#messages_count ⇒ String

Returns The number of Messages in the Channel.

Returns:

  • (String) —

    The number of Messages in the Channel



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

def messages_count
  @properties['messages_count']
end

#service_sid ⇒ String

Returns The unique id of the Service this channel belongs to.

Returns:

  • (String) —

    The unique id of the Service this channel belongs to.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



573
574
575
576
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 573

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

#type ⇒ channel.ChannelType

Returns The visibility of this channel - either public or private.

Returns:

  • (channel.ChannelType) —

    The visibility of this channel - either public or private



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

def type
  @properties['type']
end

#unique_name ⇒ String

Returns The unique, addressable name of this channel.

Returns:

  • (String) —

    The unique, addressable name of this channel.



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

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

Parameters:

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

    A human-readable name for the Channel. Optional.

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

    A unique, addressable name for the Channel. Optional.

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

    An optional metadata field you can use to store any data you wish. No processing or validation is done on this field.

  • date_created (Time) (defaults to: :unset) —

    The optional ISO8601 time specifying the datetime the Channel should be set as being created.

  • date_updated (Time) (defaults to: :unset) —

    The optional ISO8601 time specifying the datetime the Channel should be set as having been last updated.

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

    Optional field to specify the Identity of the User that created the Channel.

Returns:



532
533
534
535
536
537
538
539
540
541
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 532

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

Returns An absolute URL for this channel.

Returns:

  • (String) —

    An absolute URL for this channel.



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

def url
  @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



567
568
569
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel.rb', line 567

def webhooks
  context.webhooks
end