Class: Twilio::REST::Sync::V1::ServiceContext::SyncStreamList

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ SyncStreamList

Initialize the SyncStreamList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 20

def initialize(version, service_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Streams"
end

Instance Method Details

#create(unique_name: :unset, ttl: :unset) ⇒ SyncStreamInstance

Retrieve a single page of SyncStreamInstance records from the API. Request is executed immediately.



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 36

def create(unique_name: :unset, ttl: :unset)
  data = Twilio::Values.of({'UniqueName' => unique_name, 'Ttl' => ttl, })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  SyncStreamInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

When passed a block, yields SyncStreamInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 86

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of SyncStreamInstance records from the API. Request is executed immediately.



122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 122

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  SyncStreamPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists SyncStreamInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



59
60
61
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 59

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of SyncStreamInstance records from the API. Request is executed immediately.



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 103

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  SyncStreamPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams SyncStreamInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 74

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



132
133
134
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 132

def to_s
  '#<Twilio.Sync.V1.SyncStreamList>'
end