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

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 SyncStream resource.

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

    The SID of the Call resource to fetch.



548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 548

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

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

Returns:



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

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

Returns:



575
576
577
578
579
580
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 575

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

#created_by ⇒ String

Returns The identity of the Stream’s creator. If the Stream is created from the client SDK, the value matches the Access Token’s identity field. If the Stream was created from the REST API, the value is ‘system’.

Returns:

  • (String) —

    The identity of the Stream’s creator. If the Stream is created from the client SDK, the value matches the Access Token’s identity field. If the Stream was created from the REST API, the value is ‘system’.



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

def created_by
    @properties['created_by']
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_expires ⇒ Time

Returns The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is null. The Stream might not be deleted immediately after it expires.

Returns:

  • (Time) —

    The date and time in GMT when the Message Stream expires and will be deleted, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format. If the Message Stream does not expire, this value is null. The Stream might not be deleted immediately after it expires.



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

def date_expires
    @properties['date_expires']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SyncStreamInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ SyncStreamInstance

Fetch the SyncStreamInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of the Stream’s nested resources.

Returns:

  • (Hash) —

    The URLs of the Stream’s nested resources.



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

def links
    @properties['links']
end

#service_sid ⇒ String

Returns The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

Returns:



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

    The unique string that we created to identify the Sync Stream resource.



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

def sid
    @properties['sid']
end

#stream_messages ⇒ stream_messages

Access the stream_messages

Returns:



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

def stream_messages
    context.stream_messages
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#unique_name ⇒ String

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

Returns:

  • (String) —

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



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

def unique_name
    @properties['unique_name']
end

#update(ttl: :unset) ⇒ SyncStreamInstance

Update the SyncStreamInstance

Parameters:

Returns:



662
663
664
665
666
667
668
669
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 662

def update(
    ttl: :unset
)

    context.update(
        ttl: ttl, 
    )
end

#url ⇒ String

Returns The absolute URL of the Message Stream resource.

Returns:

  • (String) —

    The absolute URL of the Message Stream resource.



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

def url
    @properties['url']
end