Class: Twilio::REST::Sync::V1::ServiceContext::SyncStreamInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ SyncStreamInstance

Initialize the SyncStreamInstance



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 556

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'url' => payload['url'],
        'links' => payload['links'],
        'date_expires' => Twilio.deserialize_iso8601_datetime(payload['date_expires']),
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'created_by' => payload['created_by'],
    }

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

Instance Method Details

#account_sid ⇒ String 



604
605
606
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 604

def 
    @properties['account_sid']
end

#context ⇒ SyncStreamContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context



583
584
585
586
587
588
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 583

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

#created_by ⇒ String 



646
647
648
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 646

def created_by
    @properties['created_by']
end

#date_created ⇒ Time 



634
635
636
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 634

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time 



628
629
630
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 628

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time 



640
641
642
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 640

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncStreamInstance



653
654
655
656
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 653

def delete

    context.delete
end

#fetch ⇒ SyncStreamInstance

Fetch the SyncStreamInstance



661
662
663
664
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 661

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



695
696
697
698
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 695

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

#links ⇒ Hash 



622
623
624
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 622

def links
    @properties['links']
end

#service_sid ⇒ String 



610
611
612
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 610

def service_sid
    @properties['service_sid']
end

#sid ⇒ String 



592
593
594
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 592

def sid
    @properties['sid']
end

#stream_messages ⇒ stream_messages

Access the stream_messages



682
683
684
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 682

def stream_messages
    context.stream_messages
end

#to_s ⇒ Object

Provide a user friendly representation



688
689
690
691
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 688

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

#unique_name ⇒ String 



598
599
600
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 598

def unique_name
    @properties['unique_name']
end

#update(ttl: :unset) ⇒ SyncStreamInstance

Update the SyncStreamInstance



670
671
672
673
674
675
676
677
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 670

def update(
  ttl: :unset
)

    context.update(
        ttl: ttl, 
    )
end

#url ⇒ String 



616
617
618
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 616

def url
    @properties['url']
end