Class: Twilio::REST::Sync::V1::ServiceContext::DocumentContext::DocumentPermissionList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, document_sid: nil) ⇒ DocumentPermissionList

Initialize the DocumentPermissionList



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

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

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

Instance Method Details

#each ⇒ Object

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



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

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



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 105

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

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

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



44
45
46
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 44

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



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

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)

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

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

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



59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 59

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



115
116
117
 
# File 'lib/twilio-ruby/rest/sync/v1/service/document/document_permission.rb', line 115

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