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'
ResultType = 
DropboxApi::Results::ListFolderGetLatestCursorResult
ErrorType = 
DropboxApi::Errors::ListFolderError

Instance Method Summary collapse

Methods included from OptionsValidator

#validate_options

Methods inherited from Rpc

#build_connection, #build_request, #request_body

Methods inherited from Base

add_endpoint, #initialize

Constructor Details

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

Instance Method Details

#list_folder_get_latest_cursor(options = {}) ⇒ Object

A way to quickly get a cursor for the folder's state. Unlike Client#list_folder, this 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.

Options Hash (options):

  • path (String) —

    The path to the folder you want to read.

  • recursive (Boolean) —

    If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. The default for this field is false.

  • include_media_info (Boolean) —

    If true, media_info is set for photo and video. The default for this field is false.

  • include_deleted (Boolean) —

    If true, Metadata::Deleted will be returned for deleted file or folder, otherwise DropboxApi::Errors::LookupError will be returned. The default for this field is false.



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

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