Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapContext::SyncMapPermissionList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, map_sid: nil) ⇒ SyncMapPermissionList

Initialize the SyncMapPermissionList



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

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

  # Path Solution
  @solution = {service_sid: service_sid, map_sid: map_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Permissions"
end

Instance Method Details

#each ⇒ Object

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



70
71
72
73
74
75
76
77
78
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 70

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 SyncMapPermissionInstance records from the API. Request is executed immediately.



104
105
106
107
108
109
110
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 104

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

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

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



43
44
45
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 43

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 SyncMapPermissionInstance records from the API. Request is executed immediately.



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 87

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: params)

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

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

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



58
59
60
61
62
63
64
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 58

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



114
115
116
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_permission.rb', line 114

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