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.



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 343

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) 


388
389
390
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 388

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns:

  • (String) 


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

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:



373
374
375
376
377
378
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 373

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

#created_by ⇒ String

Returns:

  • (String) 


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

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns:

  • (Time) 


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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns:

  • (Time) 


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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ChannelInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ ChannelInstance

Fetch the ChannelInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns:

  • (String) 


400
401
402
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 400

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#invites ⇒ invites

Access the invites

Returns:



516
517
518
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 516

def invites
    context.invites
end

#links ⇒ Hash

Returns:

  • (Hash) 


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

def links
    @properties['links']
end

#members ⇒ members

Access the members

Returns:



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

def members
    context.members
end

#members_count ⇒ String

Returns:

  • (String) 


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

def members_count
    @properties['members_count']
end

#messages ⇒ messages

Access the messages

Returns:



509
510
511
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 509

def messages
    context.messages
end

#messages_count ⇒ String

Returns:

  • (String) 


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

def messages_count
    @properties['messages_count']
end

#service_sid ⇒ String

Returns:

  • (String) 


394
395
396
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 394

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns:

  • (String) 


382
383
384
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 382

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



522
523
524
525
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 522

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

#type ⇒ ChannelType

Returns:

  • (ChannelType) 


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

def type
    @properties['type']
end

#unique_name ⇒ String

Returns:

  • (String) 


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

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:



486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/twilio-ruby/rest/ip_messaging/v1/service/channel.rb', line 486

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) 


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

def url
    @properties['url']
end