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



24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 24

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

Create the SyncStreamInstance



44
45
46
47
48
49
50
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 44

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.



96
97
98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 96

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.



134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 134

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

#list(hide_expired: :unset, 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.



66
67
68
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 66

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

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

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



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 116

def page(hide_expired: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'HideExpired' => hide_expired,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  SyncStreamPage.new(@version, response, @solution)
end

#stream(hide_expired: :unset, 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.



84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 84

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

  page = self.page(hide_expired: hide_expired, 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



144
145
146
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_stream.rb', line 144

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