Class: Twilio::REST::IpMessaging::V1::ServiceContext::ChannelInstance

Inherits:
Twilio::REST::InstanceResource show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/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.



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/ip_messaging/v1/service/channel.rb', line 369

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:

  • (String) 


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

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


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

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
 
# File 'lib/twilio-ruby/rest/ip_messaging/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:

  • (String) 


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

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ChannelInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance

Returns:



501
502
503
504
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 501

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



555
556
557
558
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 555

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

#invites ⇒ invites

Access the invites

Returns:



542
543
544
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 542

def invites
    context.invites
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#members ⇒ members

Access the members

Returns:



528
529
530
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 528

def members
    context.members
end

#members_count ⇒ String

Returns:

  • (String) 


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

def members_count
    @properties['members_count']
end

#messages ⇒ messages

Access the messages

Returns:



535
536
537
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 535

def messages
    context.messages
end

#messages_count ⇒ String

Returns:

  • (String) 


474
475
476
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 474

def messages_count
    @properties['messages_count']
end

#service_sid ⇒ String

Returns:

  • (String) 


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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



548
549
550
551
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 548

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

#type ⇒ ChannelType

Returns:

  • (ChannelType) 


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

def type
    @properties['type']
end

#unique_name ⇒ String

Returns:

  • (String) 


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

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)
  • unique_name (String) (defaults to: :unset)
  • attributes (String) (defaults to: :unset)

Returns:



512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 512

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:

  • (String) 


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

def url
    @properties['url']
end