class Twilio::REST::Preview::Sync::ServiceContext::SyncMapContext::SyncMapPermissionList

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

Public Class Methods

new(version, service_sid: nil, map_sid: nil) click to toggle source

Initialize the SyncMapPermissionList @param [Version] version Version that contains the resource @param [String] service_sid The unique SID identifier of the Sync Service

Instance.

@param [String] map_sid The unique SID identifier of the Sync Map to which the

Permission applies.

@return [SyncMapPermissionList] SyncMapPermissionList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb
26 def initialize(version, service_sid: nil, map_sid: nil)
27   super(version)
28 
29   # Path Solution
30   @solution = {service_sid: service_sid, map_sid: map_sid}
31   @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Permissions"
32 end

Public Instance Methods

each() { |x| ... } click to toggle source

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

   # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb
72 def each
73   limits = @version.read_limits
74 
75   page = self.page(page_size: limits[:page_size], )
76 
77   @version.stream(page,
78                   limit: limits[:limit],
79                   page_limit: limits[:page_limit]).each {|x| yield x}
80 end
get_page(target_url) click to toggle source

Retrieve a single page of SyncMapPermissionInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of SyncMapPermissionInstance

    # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb
106 def get_page(target_url)
107   response = @version.domain.request(
108       'GET',
109       target_url
110   )
111   SyncMapPermissionPage.new(@version, response, @solution)
112 end
list(limit: nil, page_size: nil) click to toggle source

Lists SyncMapPermissionInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records.  If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb
45 def list(limit: nil, page_size: nil)
46   self.stream(limit: limit, page_size: page_size).entries
47 end
page(page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of SyncMapPermissionInstance records from the API. Request is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of SyncMapPermissionInstance

   # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb
89 def page(page_token: :unset, page_number: :unset, page_size: :unset)
90   params = Twilio::Values.of({
91       'PageToken' => page_token,
92       'Page' => page_number,
93       'PageSize' => page_size,
94   })
95 
96   response = @version.page('GET', @uri, params: params)
97 
98   SyncMapPermissionPage.new(@version, response, @solution)
99 end
stream(limit: nil, page_size: nil) click to toggle source

Streams SyncMapPermissionInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb
60 def stream(limit: nil, page_size: nil)
61   limits = @version.read_limits(limit, page_size)
62 
63   page = self.page(page_size: limits[:page_size], )
64 
65   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
66 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/preview/sync/service/sync_map/sync_map_permission.rb
116 def to_s
117   '#<Twilio.Preview.Sync.SyncMapPermissionList>'
118 end