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

  • account_sid (String) —

    The SID of the Account that created this Channel resource.

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

    The SID of the Call resource to fetch.



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 352

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

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/api/rest/account) that created the Channel resource.

Returns:



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

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns The JSON string that stores application-specific data. Note If this property has been assigned a value, it’s only displayed in a FETCH action that returns a single resource; otherwise, it’s null. If the attributes have not been set, ‘{}` is returned.

Returns:

  • (String) —

    The JSON string that stores application-specific data. Note If this property has been assigned a value, it’s only displayed in a FETCH action that returns a single resource; otherwise, it’s null. If the attributes have not been set, ‘{}` is returned.



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

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:



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

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

#created_by ⇒ String

Returns The ‘identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.

Returns:

  • (String) —

    The ‘identity` of the User that created the channel. If the Channel was created by using the API, the value is `system`.



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

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ChannelInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#invites ⇒ invites

Access the invites

Returns:



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

def invites
    context.invites
end

#links ⇒ Hash

Returns The absolute URLs of the [Members](www.twilio.com/docs/chat/api/members), [Messages](www.twilio.com/docs/chat/api/messages) , [Invites](www.twilio.com/docs/chat/api/invites) and, if it exists, the last [Message](www.twilio.com/docs/chat/api/messages) for the Channel.

Returns:



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

def links
    @properties['links']
end

#members ⇒ members

Access the members

Returns:



511
512
513
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 511

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.



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

def members_count
    @properties['members_count']
end

#messages ⇒ messages

Access the messages

Returns:



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

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.



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

def messages_count
    @properties['messages_count']
end

#service_sid ⇒ String

Returns The SID of the [Service](www.twilio.com/docs/api/chat/rest/services) the resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Channel resource.

Returns:

  • (String) —

    The unique string that we created to identify the Channel resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#type ⇒ ChannelType

Returns:

  • (ChannelType) 


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

def type
    @properties['type']
end

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL.



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

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) —

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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

    An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.

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

    A valid JSON string that contains application-specific data.

Returns:



495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/twilio-ruby/rest/chat/v1/service/channel.rb', line 495

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 absolute URL of the Channel resource.

Returns:

  • (String) —

    The absolute URL of the Channel resource.



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

def url
    @properties['url']
end