Class: DropboxApi::Endpoints::Files::ListFolderGetLatestCursor

Inherits:
Rpc
  • Object
show all
Includes:
OptionsValidator
Defined in:
lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb

Constant Summary collapse

Method = 
:post
Path = 
"/2/files/list_folder/get_latest_cursor".freeze
ResultType = 
DropboxApi::Results::ListFolderGetLatestCursorResult
ErrorType = 
DropboxApi::Errors::ListFolderError

Instance Method Summary collapse

Methods included from OptionsValidator

#validate_options

Methods inherited from Rpc

#build_request, #initialize

Methods inherited from Base

add_endpoint

Constructor Details

This class inherits a constructor from DropboxApi::Endpoints::Rpc

Instance Method Details

#list_folder_get_latest_cursor(options) ⇒ Object

A way to quickly get a cursor for the folder’s state. Unlike list_folder, list_folder_get_latest_cursor doesn’t return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn’t need to know about files that already exist in Dropbox.

Parameters:

  • path (String) —

    The path to the folder you want to read.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb', line 25

add_endpoint :list_folder_get_latest_cursor do |options = {}|
  validate_options([
    :path,
    :recursive,
    :include_media_info,
    :include_deleted,
    :include_has_explicit_shared_members
  ], options)
  options[:recursive] ||= false
  options[:include_media_info] ||= false
  options[:include_deleted] ||= false

  perform_request options
end