dropbox_api 0.1.14 → 0.1.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (494) hide show
  1. checksums.yaml +5 -5
  2. data/.gitignore +1 -1
  3. data/.rubocop.yml +15 -0
  4. data/.travis.yml +1 -2
  5. data/.yardopts +1 -0
  6. data/Gemfile +6 -1
  7. data/README.md +7 -2
  8. data/Rakefile +4 -3
  9. data/TODO.md +16 -6
  10. data/api_coverage.md +8 -8
  11. data/bin/console +4 -3
  12. data/docs/DropboxApi.html +135 -0
  13. data/docs/DropboxApi/Authenticator.html +217 -0
  14. data/docs/DropboxApi/ChunkedUploader.html +411 -0
  15. data/docs/DropboxApi/Client.html +10106 -0
  16. data/docs/DropboxApi/ConnectionBuilder.html +326 -0
  17. data/docs/DropboxApi/Endpoints.html +119 -0
  18. data/docs/DropboxApi/Endpoints/Auth.html +115 -0
  19. data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +265 -0
  20. data/docs/DropboxApi/Endpoints/Base.html +197 -0
  21. data/docs/DropboxApi/Endpoints/ContentDownload.html +383 -0
  22. data/docs/DropboxApi/Endpoints/ContentUpload.html +351 -0
  23. data/docs/DropboxApi/Endpoints/Files.html +117 -0
  24. data/docs/DropboxApi/Endpoints/Files/Copy.html +323 -0
  25. data/docs/DropboxApi/Endpoints/Files/CopyBatch.html +359 -0
  26. data/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html +305 -0
  27. data/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +304 -0
  28. data/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +320 -0
  29. data/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +307 -0
  30. data/docs/DropboxApi/Endpoints/Files/CreateFolder.html +305 -0
  31. data/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html +377 -0
  32. data/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html +308 -0
  33. data/docs/DropboxApi/Endpoints/Files/Delete.html +341 -0
  34. data/docs/DropboxApi/Endpoints/Files/DeleteBatch.html +305 -0
  35. data/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html +307 -0
  36. data/docs/DropboxApi/Endpoints/Files/Download.html +284 -0
  37. data/docs/DropboxApi/Endpoints/Files/GetMetadata.html +376 -0
  38. data/docs/DropboxApi/Endpoints/Files/GetPreview.html +286 -0
  39. data/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +286 -0
  40. data/docs/DropboxApi/Endpoints/Files/GetThumbnail.html +388 -0
  41. data/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +431 -0
  42. data/docs/DropboxApi/Endpoints/Files/ListFolder.html +402 -0
  43. data/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +298 -0
  44. data/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +371 -0
  45. data/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +360 -0
  46. data/docs/DropboxApi/Endpoints/Files/ListRevisions.html +338 -0
  47. data/docs/DropboxApi/Endpoints/Files/Move.html +364 -0
  48. data/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +337 -0
  49. data/docs/DropboxApi/Endpoints/Files/Restore.html +305 -0
  50. data/docs/DropboxApi/Endpoints/Files/SaveUrl.html +324 -0
  51. data/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +306 -0
  52. data/docs/DropboxApi/Endpoints/Files/Search.html +399 -0
  53. data/docs/DropboxApi/Endpoints/Files/Upload.html +439 -0
  54. data/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +377 -0
  55. data/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +328 -0
  56. data/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +350 -0
  57. data/docs/DropboxApi/Endpoints/Rpc.html +353 -0
  58. data/docs/DropboxApi/Endpoints/RpcContent.html +236 -0
  59. data/docs/DropboxApi/Endpoints/RpcNotify.html +240 -0
  60. data/docs/DropboxApi/Endpoints/Sharing.html +117 -0
  61. data/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +415 -0
  62. data/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +400 -0
  63. data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +413 -0
  64. data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html +344 -0
  65. data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html +421 -0
  66. data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html +400 -0
  67. data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html +345 -0
  68. data/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html +293 -0
  69. data/docs/DropboxApi/Endpoints/Sharing/ShareFolder.html +428 -0
  70. data/docs/DropboxApi/Endpoints/Sharing/UnshareFile.html +290 -0
  71. data/docs/DropboxApi/Endpoints/Users.html +117 -0
  72. data/docs/DropboxApi/Endpoints/Users/GetAccount.html +301 -0
  73. data/docs/DropboxApi/Endpoints/Users/GetAccountBatch.html +303 -0
  74. data/docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html +282 -0
  75. data/docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html +282 -0
  76. data/docs/DropboxApi/Errors.html +117 -0
  77. data/docs/DropboxApi/Errors/AddFileMemberError.html +164 -0
  78. data/docs/DropboxApi/Errors/AddFolderMemberError.html +170 -0
  79. data/docs/DropboxApi/Errors/AddMemberSelectorError.html +165 -0
  80. data/docs/DropboxApi/Errors/AlreadySharedError.html +213 -0
  81. data/docs/DropboxApi/Errors/BadPathError.html +143 -0
  82. data/docs/DropboxApi/Errors/BasicError.html +356 -0
  83. data/docs/DropboxApi/Errors/CantCopySharedFolderError.html +143 -0
  84. data/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +143 -0
  85. data/docs/DropboxApi/Errors/CantNestSharedFolderError.html +143 -0
  86. data/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +143 -0
  87. data/docs/DropboxApi/Errors/ContainsSharedFolderError.html +143 -0
  88. data/docs/DropboxApi/Errors/ConversionError.html +143 -0
  89. data/docs/DropboxApi/Errors/CreateFileRequestError.html +160 -0
  90. data/docs/DropboxApi/Errors/CreateFolderBatchError.html +161 -0
  91. data/docs/DropboxApi/Errors/CreateFolderError.html +161 -0
  92. data/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +165 -0
  93. data/docs/DropboxApi/Errors/CursorClosedError.html +143 -0
  94. data/docs/DropboxApi/Errors/CursorNotClosedError.html +143 -0
  95. data/docs/DropboxApi/Errors/DeleteError.html +163 -0
  96. data/docs/DropboxApi/Errors/DisallowedNameError.html +143 -0
  97. data/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +143 -0
  98. data/docs/DropboxApi/Errors/DownloadError.html +161 -0
  99. data/docs/DropboxApi/Errors/DownloadFailedError.html +143 -0
  100. data/docs/DropboxApi/Errors/EmailUnverifiedError.html +143 -0
  101. data/docs/DropboxApi/Errors/FileAncestorConflictError.html +143 -0
  102. data/docs/DropboxApi/Errors/FileConflictError.html +143 -0
  103. data/docs/DropboxApi/Errors/FileMemberActionError.html +164 -0
  104. data/docs/DropboxApi/Errors/FolderConflictError.html +143 -0
  105. data/docs/DropboxApi/Errors/GetAccountError.html +161 -0
  106. data/docs/DropboxApi/Errors/GetCopyReferenceError.html +161 -0
  107. data/docs/DropboxApi/Errors/GetMetadataError.html +161 -0
  108. data/docs/DropboxApi/Errors/GroupDeletedError.html +143 -0
  109. data/docs/DropboxApi/Errors/GroupNotOnTeamError.html +143 -0
  110. data/docs/DropboxApi/Errors/HttpError.html +124 -0
  111. data/docs/DropboxApi/Errors/InProgressError.html +143 -0
  112. data/docs/DropboxApi/Errors/InsideAppFolderError.html +143 -0
  113. data/docs/DropboxApi/Errors/InsideOsxPackageError.html +143 -0
  114. data/docs/DropboxApi/Errors/InsidePublicFolderError.html +143 -0
  115. data/docs/DropboxApi/Errors/InsideSharedFolderError.html +143 -0
  116. data/docs/DropboxApi/Errors/InsufficientPlanError.html +143 -0
  117. data/docs/DropboxApi/Errors/InsufficientSpaceError.html +143 -0
  118. data/docs/DropboxApi/Errors/InternalError.html +143 -0
  119. data/docs/DropboxApi/Errors/InvalidCommentError.html +143 -0
  120. data/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +143 -0
  121. data/docs/DropboxApi/Errors/InvalidCursorError.html +143 -0
  122. data/docs/DropboxApi/Errors/InvalidDropboxIdError.html +143 -0
  123. data/docs/DropboxApi/Errors/InvalidEmailError.html +143 -0
  124. data/docs/DropboxApi/Errors/InvalidFileError.html +143 -0
  125. data/docs/DropboxApi/Errors/InvalidIdError.html +143 -0
  126. data/docs/DropboxApi/Errors/InvalidMemberError.html +143 -0
  127. data/docs/DropboxApi/Errors/InvalidPathError.html +143 -0
  128. data/docs/DropboxApi/Errors/InvalidRevisionError.html +143 -0
  129. data/docs/DropboxApi/Errors/InvalidSettingsError.html +143 -0
  130. data/docs/DropboxApi/Errors/InvalidUrlError.html +143 -0
  131. data/docs/DropboxApi/Errors/IsAppFolderError.html +143 -0
  132. data/docs/DropboxApi/Errors/IsFileError.html +143 -0
  133. data/docs/DropboxApi/Errors/IsFolderError.html +143 -0
  134. data/docs/DropboxApi/Errors/IsOsxPackageError.html +143 -0
  135. data/docs/DropboxApi/Errors/IsPublicFolderError.html +143 -0
  136. data/docs/DropboxApi/Errors/ListFolderContinueError.html +162 -0
  137. data/docs/DropboxApi/Errors/ListFolderError.html +161 -0
  138. data/docs/DropboxApi/Errors/ListFolderLongpollError.html +161 -0
  139. data/docs/DropboxApi/Errors/ListRevisionsError.html +161 -0
  140. data/docs/DropboxApi/Errors/ListSharedLinksError.html +162 -0
  141. data/docs/DropboxApi/Errors/LookupError.html +165 -0
  142. data/docs/DropboxApi/Errors/MalformedPathError.html +143 -0
  143. data/docs/DropboxApi/Errors/NoAccountError.html +143 -0
  144. data/docs/DropboxApi/Errors/NoPermissionError.html +143 -0
  145. data/docs/DropboxApi/Errors/NoWritePermissionError.html +143 -0
  146. data/docs/DropboxApi/Errors/NotAMemberError.html +143 -0
  147. data/docs/DropboxApi/Errors/NotFileError.html +143 -0
  148. data/docs/DropboxApi/Errors/NotFolderError.html +143 -0
  149. data/docs/DropboxApi/Errors/NotFoundError.html +143 -0
  150. data/docs/DropboxApi/Errors/PollError.html +162 -0
  151. data/docs/DropboxApi/Errors/PreviewError.html +164 -0
  152. data/docs/DropboxApi/Errors/RateLimitError.html +143 -0
  153. data/docs/DropboxApi/Errors/RelocationBatchEntryError.html +163 -0
  154. data/docs/DropboxApi/Errors/RelocationError.html +167 -0
  155. data/docs/DropboxApi/Errors/RestoreError.html +163 -0
  156. data/docs/DropboxApi/Errors/RestrictedContentError.html +143 -0
  157. data/docs/DropboxApi/Errors/RevokeSharedLinkError.html +164 -0
  158. data/docs/DropboxApi/Errors/SaveCopyReferenceError.html +165 -0
  159. data/docs/DropboxApi/Errors/SaveUrlError.html +164 -0
  160. data/docs/DropboxApi/Errors/SearchError.html +161 -0
  161. data/docs/DropboxApi/Errors/SettingsError.html +162 -0
  162. data/docs/DropboxApi/Errors/ShareFolderError.html +165 -0
  163. data/docs/DropboxApi/Errors/SharePathError.html +171 -0
  164. data/docs/DropboxApi/Errors/SharedFolderAccessError.html +164 -0
  165. data/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +143 -0
  166. data/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +143 -0
  167. data/docs/DropboxApi/Errors/SharedLinkError.html +163 -0
  168. data/docs/DropboxApi/Errors/SharedLinkMalformedError.html +143 -0
  169. data/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +143 -0
  170. data/docs/DropboxApi/Errors/SharingFileAccessError.html +165 -0
  171. data/docs/DropboxApi/Errors/SharingUserError.html +161 -0
  172. data/docs/DropboxApi/Errors/TeamFolderError.html +143 -0
  173. data/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +143 -0
  174. data/docs/DropboxApi/Errors/ThumbnailBatchError.html +161 -0
  175. data/docs/DropboxApi/Errors/ThumbnailError.html +164 -0
  176. data/docs/DropboxApi/Errors/TooManyFilesError.html +143 -0
  177. data/docs/DropboxApi/Errors/TooManyMembersError.html +143 -0
  178. data/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +143 -0
  179. data/docs/DropboxApi/Errors/TooManyRequestsError.html +321 -0
  180. data/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +143 -0
  181. data/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +167 -0
  182. data/docs/DropboxApi/Errors/UnmountedError.html +143 -0
  183. data/docs/DropboxApi/Errors/UnshareFileError.html +162 -0
  184. data/docs/DropboxApi/Errors/UnsupportedContentError.html +143 -0
  185. data/docs/DropboxApi/Errors/UnsupportedExtensionError.html +143 -0
  186. data/docs/DropboxApi/Errors/UnsupportedImageError.html +143 -0
  187. data/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +143 -0
  188. data/docs/DropboxApi/Errors/UnverifiedDropboxId.html +143 -0
  189. data/docs/DropboxApi/Errors/UploadError.html +161 -0
  190. data/docs/DropboxApi/Errors/UploadSessionFinishError.html +163 -0
  191. data/docs/DropboxApi/Errors/UploadSessionLookupError.html +164 -0
  192. data/docs/DropboxApi/Errors/UploadSessionOffsetError.html +220 -0
  193. data/docs/DropboxApi/Errors/UploadWriteFailedError.html +161 -0
  194. data/docs/DropboxApi/Errors/WriteConflictError.html +163 -0
  195. data/docs/DropboxApi/Errors/WriteError.html +165 -0
  196. data/docs/DropboxApi/Metadata.html +117 -0
  197. data/docs/DropboxApi/Metadata/AccessLevel.html +259 -0
  198. data/docs/DropboxApi/Metadata/AddFileMemberResult.html +164 -0
  199. data/docs/DropboxApi/Metadata/AddMember.html +246 -0
  200. data/docs/DropboxApi/Metadata/Base.html +545 -0
  201. data/docs/DropboxApi/Metadata/BasicAccount.html +167 -0
  202. data/docs/DropboxApi/Metadata/CommitInfo.html +232 -0
  203. data/docs/DropboxApi/Metadata/Deleted.html +158 -0
  204. data/docs/DropboxApi/Metadata/Dimensions.html +140 -0
  205. data/docs/DropboxApi/Metadata/Field.html +358 -0
  206. data/docs/DropboxApi/Metadata/File.html +238 -0
  207. data/docs/DropboxApi/Metadata/FileLinkMetadata.html +180 -0
  208. data/docs/DropboxApi/Metadata/FileMemberAction.html +230 -0
  209. data/docs/DropboxApi/Metadata/FileRequest.html +167 -0
  210. data/docs/DropboxApi/Metadata/Folder.html +228 -0
  211. data/docs/DropboxApi/Metadata/FolderLinkMetadata.html +140 -0
  212. data/docs/DropboxApi/Metadata/FolderSharingInfo.html +156 -0
  213. data/docs/DropboxApi/Metadata/LinkPermissions.html +161 -0
  214. data/docs/DropboxApi/Metadata/Location.html +140 -0
  215. data/docs/DropboxApi/Metadata/MediaInfo.html +245 -0
  216. data/docs/DropboxApi/Metadata/MediaMetadata.html +237 -0
  217. data/docs/DropboxApi/Metadata/Member.html +313 -0
  218. data/docs/DropboxApi/Metadata/MemberAction.html +274 -0
  219. data/docs/DropboxApi/Metadata/MemberActionList.html +221 -0
  220. data/docs/DropboxApi/Metadata/MemberPermission.html +163 -0
  221. data/docs/DropboxApi/Metadata/MemberPermissionList.html +237 -0
  222. data/docs/DropboxApi/Metadata/Name.html +158 -0
  223. data/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +140 -0
  224. data/docs/DropboxApi/Metadata/PhotoMetadata.html +164 -0
  225. data/docs/DropboxApi/Metadata/Resource.html +207 -0
  226. data/docs/DropboxApi/Metadata/SharedFolder.html +165 -0
  227. data/docs/DropboxApi/Metadata/SharedFolderPolicy.html +156 -0
  228. data/docs/DropboxApi/Metadata/SharedLink.html +375 -0
  229. data/docs/DropboxApi/Metadata/SharedLinkMetadata.html +204 -0
  230. data/docs/DropboxApi/Metadata/SpaceAllocation.html +156 -0
  231. data/docs/DropboxApi/Metadata/SpaceUsage.html +159 -0
  232. data/docs/DropboxApi/Metadata/Tag.html +293 -0
  233. data/docs/DropboxApi/Metadata/Team.html +140 -0
  234. data/docs/DropboxApi/Metadata/TeamMemberInfo.html +160 -0
  235. data/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +140 -0
  236. data/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +221 -0
  237. data/docs/DropboxApi/Metadata/UploadSessionCursor.html +226 -0
  238. data/docs/DropboxApi/Metadata/VideoMetadata.html +165 -0
  239. data/docs/DropboxApi/Metadata/WriteMode.html +439 -0
  240. data/docs/DropboxApi/MiddleWare.html +117 -0
  241. data/docs/DropboxApi/MiddleWare/DecodeResult.html +273 -0
  242. data/docs/DropboxApi/MiddleWare/Stack.html +452 -0
  243. data/docs/DropboxApi/OptionsValidator.html +234 -0
  244. data/docs/DropboxApi/ResultBuilder.html +570 -0
  245. data/docs/DropboxApi/Results.html +119 -0
  246. data/docs/DropboxApi/Results/AddFileMemberResultList.html +227 -0
  247. data/docs/DropboxApi/Results/Base.html +206 -0
  248. data/docs/DropboxApi/Results/BasicAccountBatch.html +205 -0
  249. data/docs/DropboxApi/Results/CopyBatchResult.html +224 -0
  250. data/docs/DropboxApi/Results/CreateFolderBatchResult.html +241 -0
  251. data/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html +234 -0
  252. data/docs/DropboxApi/Results/DeleteBatchResult.html +241 -0
  253. data/docs/DropboxApi/Results/DeleteBatchResultEntry.html +226 -0
  254. data/docs/DropboxApi/Results/GetCopyReferenceResult.html +351 -0
  255. data/docs/DropboxApi/Results/GetTemporaryLinkResult.html +263 -0
  256. data/docs/DropboxApi/Results/GetThumbnailBatchResult.html +214 -0
  257. data/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +210 -0
  258. data/docs/DropboxApi/Results/ListFolderLongpollResult.html +287 -0
  259. data/docs/DropboxApi/Results/ListFolderResult.html +368 -0
  260. data/docs/DropboxApi/Results/ListRevisionsResult.html +300 -0
  261. data/docs/DropboxApi/Results/ListSharedLinksResult.html +368 -0
  262. data/docs/DropboxApi/Results/RelocationBatchResult.html +241 -0
  263. data/docs/DropboxApi/Results/RelocationBatchResultEntry.html +226 -0
  264. data/docs/DropboxApi/Results/SaveCopyReferenceResult.html +221 -0
  265. data/docs/DropboxApi/Results/SaveUrlJobStatus.html +230 -0
  266. data/docs/DropboxApi/Results/SaveUrlResult.html +227 -0
  267. data/docs/DropboxApi/Results/Search.html +115 -0
  268. data/docs/DropboxApi/Results/Search/Match.html +314 -0
  269. data/docs/DropboxApi/Results/SearchResult.html +368 -0
  270. data/docs/DropboxApi/Results/ShareFolderLaunch.html +205 -0
  271. data/docs/DropboxApi/Results/SharedFileMembers.html +369 -0
  272. data/docs/DropboxApi/Results/SharedFolderMembers.html +369 -0
  273. data/docs/DropboxApi/Results/UploadSessionStart.html +210 -0
  274. data/docs/DropboxApi/Results/VoidResult.html +140 -0
  275. data/docs/DropboxScaffoldBuilder.html +1172 -0
  276. data/docs/_index.html +2110 -0
  277. data/docs/class_list.html +51 -0
  278. data/docs/css/common.css +4 -0
  279. data/docs/css/full_list.css +58 -0
  280. data/docs/css/style.css +496 -0
  281. data/docs/file.README.html +257 -0
  282. data/docs/file.api_coverage.html +595 -0
  283. data/docs/file.rails_setup.html +152 -0
  284. data/docs/file_list.html +66 -0
  285. data/docs/frames.html +17 -0
  286. data/docs/index.html +257 -0
  287. data/docs/js/app.js +303 -0
  288. data/docs/js/full_list.js +216 -0
  289. data/docs/js/jquery.js +4 -0
  290. data/docs/method_list.html +1955 -0
  291. data/docs/top-level-namespace.html +112 -0
  292. data/dropbox_api.gemspec +15 -16
  293. data/lib/dropbox_api.rb +30 -3
  294. data/lib/dropbox_api/authenticator.rb +3 -2
  295. data/lib/dropbox_api/chunked_uploader.rb +2 -0
  296. data/lib/dropbox_api/client.rb +2 -1
  297. data/lib/dropbox_api/connection_builder.rb +1 -0
  298. data/lib/dropbox_api/endpoints/auth/token_revoke.rb +2 -1
  299. data/lib/dropbox_api/endpoints/base.rb +7 -4
  300. data/lib/dropbox_api/endpoints/content_download.rb +4 -6
  301. data/lib/dropbox_api/endpoints/content_upload.rb +2 -1
  302. data/lib/dropbox_api/endpoints/file_requests/create_file_request.rb +2 -1
  303. data/lib/dropbox_api/endpoints/files/copy.rb +4 -3
  304. data/lib/dropbox_api/endpoints/files/copy_batch.rb +36 -0
  305. data/lib/dropbox_api/endpoints/files/copy_batch_check.rb +21 -0
  306. data/lib/dropbox_api/endpoints/files/copy_reference_get.rb +3 -2
  307. data/lib/dropbox_api/endpoints/files/copy_reference_save.rb +4 -3
  308. data/lib/dropbox_api/endpoints/files/create_folder.rb +3 -2
  309. data/lib/dropbox_api/endpoints/files/create_folder_batch.rb +41 -0
  310. data/lib/dropbox_api/endpoints/files/create_folder_batch_check.rb +22 -0
  311. data/lib/dropbox_api/endpoints/files/delete.rb +3 -2
  312. data/lib/dropbox_api/endpoints/files/delete_batch.rb +23 -0
  313. data/lib/dropbox_api/endpoints/files/delete_batch_check.rb +21 -0
  314. data/lib/dropbox_api/endpoints/files/download.rb +3 -2
  315. data/lib/dropbox_api/endpoints/files/get_metadata.rb +3 -2
  316. data/lib/dropbox_api/endpoints/files/get_preview.rb +3 -2
  317. data/lib/dropbox_api/endpoints/files/get_temporary_link.rb +3 -2
  318. data/lib/dropbox_api/endpoints/files/get_thumbnail.rb +3 -2
  319. data/lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb +4 -3
  320. data/lib/dropbox_api/endpoints/files/list_folder.rb +11 -4
  321. data/lib/dropbox_api/endpoints/files/list_folder_continue.rb +3 -2
  322. data/lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb +2 -1
  323. data/lib/dropbox_api/endpoints/files/list_folder_longpoll.rb +3 -2
  324. data/lib/dropbox_api/endpoints/files/list_revisions.rb +3 -2
  325. data/lib/dropbox_api/endpoints/files/move.rb +4 -3
  326. data/lib/dropbox_api/endpoints/files/permanently_delete.rb +3 -2
  327. data/lib/dropbox_api/endpoints/files/restore.rb +4 -3
  328. data/lib/dropbox_api/endpoints/files/save_url.rb +4 -3
  329. data/lib/dropbox_api/endpoints/files/save_url_check_job_status.rb +3 -2
  330. data/lib/dropbox_api/endpoints/files/search.rb +16 -27
  331. data/lib/dropbox_api/endpoints/files/upload.rb +3 -2
  332. data/lib/dropbox_api/endpoints/files/upload_session_append_v2.rb +3 -2
  333. data/lib/dropbox_api/endpoints/files/upload_session_finish.rb +4 -3
  334. data/lib/dropbox_api/endpoints/files/upload_session_start.rb +4 -3
  335. data/lib/dropbox_api/endpoints/rpc.rb +2 -1
  336. data/lib/dropbox_api/endpoints/rpc_content.rb +2 -1
  337. data/lib/dropbox_api/endpoints/rpc_notify.rb +2 -1
  338. data/lib/dropbox_api/endpoints/sharing/add_file_member.rb +4 -3
  339. data/lib/dropbox_api/endpoints/sharing/add_folder_member.rb +4 -3
  340. data/lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb +29 -4
  341. data/lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb +3 -2
  342. data/lib/dropbox_api/endpoints/sharing/list_file_members.rb +4 -3
  343. data/lib/dropbox_api/endpoints/sharing/list_folder_members.rb +4 -3
  344. data/lib/dropbox_api/endpoints/sharing/list_shared_links.rb +2 -1
  345. data/lib/dropbox_api/endpoints/sharing/revoke_shared_link.rb +24 -0
  346. data/lib/dropbox_api/endpoints/sharing/share_folder.rb +3 -2
  347. data/lib/dropbox_api/endpoints/sharing/unshare_file.rb +3 -2
  348. data/lib/dropbox_api/endpoints/users/get_account.rb +3 -2
  349. data/lib/dropbox_api/endpoints/users/get_account_batch.rb +3 -2
  350. data/lib/dropbox_api/endpoints/users/get_current_account.rb +2 -1
  351. data/lib/dropbox_api/endpoints/users/get_space_usage.rb +2 -1
  352. data/lib/dropbox_api/endpoints/virtual/upload_by_chunks.rb +1 -0
  353. data/lib/dropbox_api/errors/add_file_member_error.rb +5 -4
  354. data/lib/dropbox_api/errors/add_folder_member_error.rb +11 -10
  355. data/lib/dropbox_api/errors/add_member_selector_error.rb +6 -5
  356. data/lib/dropbox_api/errors/already_shared_error.rb +1 -0
  357. data/lib/dropbox_api/errors/basic_error.rb +3 -1
  358. data/lib/dropbox_api/errors/create_file_request_error.rb +1 -0
  359. data/lib/dropbox_api/errors/create_folder_batch_error.rb +8 -0
  360. data/lib/dropbox_api/errors/create_folder_error.rb +2 -1
  361. data/lib/dropbox_api/errors/create_shared_link_with_settings_error.rb +6 -5
  362. data/lib/dropbox_api/errors/delete_error.rb +5 -3
  363. data/lib/dropbox_api/errors/download_error.rb +2 -1
  364. data/lib/dropbox_api/errors/file_member_action_error.rb +5 -4
  365. data/lib/dropbox_api/errors/get_account_error.rb +2 -1
  366. data/lib/dropbox_api/errors/get_copy_reference_error.rb +2 -1
  367. data/lib/dropbox_api/errors/get_metadata_error.rb +2 -1
  368. data/lib/dropbox_api/errors/http_error.rb +1 -0
  369. data/lib/dropbox_api/errors/list_folder_continue_error.rb +3 -2
  370. data/lib/dropbox_api/errors/list_folder_error.rb +2 -1
  371. data/lib/dropbox_api/errors/list_folder_longpoll_error.rb +2 -1
  372. data/lib/dropbox_api/errors/list_revisions_error.rb +2 -1
  373. data/lib/dropbox_api/errors/list_shared_links_error.rb +3 -2
  374. data/lib/dropbox_api/errors/lookup_error.rb +6 -5
  375. data/lib/dropbox_api/errors/poll_error.rb +3 -2
  376. data/lib/dropbox_api/errors/preview_error.rb +5 -4
  377. data/lib/dropbox_api/errors/relocation_batch_entry_error.rb +10 -0
  378. data/lib/dropbox_api/errors/relocation_error.rb +8 -7
  379. data/lib/dropbox_api/errors/restore_error.rb +4 -3
  380. data/lib/dropbox_api/errors/revoke_shared_link_error.rb +11 -0
  381. data/lib/dropbox_api/errors/save_copy_reference_error.rb +6 -5
  382. data/lib/dropbox_api/errors/save_url_error.rb +5 -4
  383. data/lib/dropbox_api/errors/search_error.rb +2 -1
  384. data/lib/dropbox_api/errors/settings_error.rb +3 -2
  385. data/lib/dropbox_api/errors/share_folder_error.rb +6 -5
  386. data/lib/dropbox_api/errors/share_path_error.rb +12 -11
  387. data/lib/dropbox_api/errors/shared_folder_access_error.rb +5 -4
  388. data/lib/dropbox_api/errors/shared_link_error.rb +4 -3
  389. data/lib/dropbox_api/errors/sharing_file_access_error.rb +6 -5
  390. data/lib/dropbox_api/errors/sharing_user_error.rb +2 -1
  391. data/lib/dropbox_api/errors/thumbnail_batch_error.rb +2 -1
  392. data/lib/dropbox_api/errors/thumbnail_error.rb +5 -4
  393. data/lib/dropbox_api/errors/too_many_requests_error.rb +3 -2
  394. data/lib/dropbox_api/errors/unshare_file_error.rb +3 -2
  395. data/lib/dropbox_api/errors/upload_error.rb +2 -1
  396. data/lib/dropbox_api/errors/upload_session_finish_error.rb +4 -3
  397. data/lib/dropbox_api/errors/upload_session_lookup_error.rb +5 -4
  398. data/lib/dropbox_api/errors/upload_session_offset_error.rb +1 -0
  399. data/lib/dropbox_api/errors/upload_write_failed_error.rb +2 -1
  400. data/lib/dropbox_api/errors/write_conflict_error.rb +4 -3
  401. data/lib/dropbox_api/errors/write_error.rb +6 -5
  402. data/lib/dropbox_api/metadata/access_level.rb +1 -0
  403. data/lib/dropbox_api/metadata/add_file_member_result.rb +1 -0
  404. data/lib/dropbox_api/metadata/add_member.rb +3 -2
  405. data/lib/dropbox_api/metadata/base.rb +2 -1
  406. data/lib/dropbox_api/metadata/basic_account.rb +1 -0
  407. data/lib/dropbox_api/metadata/commit_info.rb +2 -1
  408. data/lib/dropbox_api/metadata/deleted.rb +1 -0
  409. data/lib/dropbox_api/metadata/dimensions.rb +1 -0
  410. data/lib/dropbox_api/metadata/field.rb +7 -4
  411. data/lib/dropbox_api/metadata/file.rb +4 -3
  412. data/lib/dropbox_api/metadata/file_categories_list.rb +9 -0
  413. data/lib/dropbox_api/metadata/file_category.rb +22 -0
  414. data/lib/dropbox_api/metadata/file_extensions_list.rb +13 -0
  415. data/lib/dropbox_api/metadata/file_link_metadata.rb +1 -0
  416. data/lib/dropbox_api/metadata/file_member_action.rb +2 -1
  417. data/lib/dropbox_api/metadata/file_request.rb +1 -0
  418. data/lib/dropbox_api/metadata/file_status.rb +14 -0
  419. data/lib/dropbox_api/metadata/folder.rb +2 -1
  420. data/lib/dropbox_api/metadata/folder_link_metadata.rb +1 -0
  421. data/lib/dropbox_api/metadata/folder_sharing_info.rb +1 -0
  422. data/lib/dropbox_api/metadata/link_permissions.rb +1 -0
  423. data/lib/dropbox_api/metadata/location.rb +1 -0
  424. data/lib/dropbox_api/metadata/media_info.rb +1 -0
  425. data/lib/dropbox_api/metadata/media_metadata.rb +1 -0
  426. data/lib/dropbox_api/metadata/member.rb +6 -5
  427. data/lib/dropbox_api/metadata/member_action.rb +1 -0
  428. data/lib/dropbox_api/metadata/member_action_list.rb +1 -0
  429. data/lib/dropbox_api/metadata/member_permission.rb +1 -0
  430. data/lib/dropbox_api/metadata/member_permission_list.rb +1 -0
  431. data/lib/dropbox_api/metadata/metadata_v2.rb +7 -0
  432. data/lib/dropbox_api/metadata/name.rb +1 -0
  433. data/lib/dropbox_api/metadata/parent_folder_access_info.rb +1 -0
  434. data/lib/dropbox_api/metadata/photo_metadata.rb +1 -0
  435. data/lib/dropbox_api/metadata/resource.rb +2 -1
  436. data/lib/dropbox_api/metadata/search_match_field_options.rb +9 -0
  437. data/lib/dropbox_api/metadata/search_match_type_v2.rb +16 -0
  438. data/lib/dropbox_api/metadata/search_match_v2.rb +18 -0
  439. data/lib/dropbox_api/metadata/search_options.rb +33 -0
  440. data/lib/dropbox_api/metadata/search_order_by.rb +14 -0
  441. data/lib/dropbox_api/metadata/shared_folder.rb +1 -0
  442. data/lib/dropbox_api/metadata/shared_folder_policy.rb +1 -0
  443. data/lib/dropbox_api/metadata/shared_link.rb +3 -2
  444. data/lib/dropbox_api/metadata/shared_link_metadata.rb +2 -1
  445. data/lib/dropbox_api/metadata/space_allocation.rb +1 -0
  446. data/lib/dropbox_api/metadata/space_usage.rb +1 -0
  447. data/lib/dropbox_api/metadata/tag.rb +2 -1
  448. data/lib/dropbox_api/metadata/team.rb +1 -0
  449. data/lib/dropbox_api/metadata/team_member_info.rb +1 -0
  450. data/lib/dropbox_api/metadata/thumbnail_batch_result_data.rb +1 -0
  451. data/lib/dropbox_api/metadata/thumbnail_batch_result_entry.rb +3 -2
  452. data/lib/dropbox_api/metadata/upload_session_cursor.rb +1 -0
  453. data/lib/dropbox_api/metadata/video_metadata.rb +1 -0
  454. data/lib/dropbox_api/metadata/write_mode.rb +6 -5
  455. data/lib/dropbox_api/middleware/decode_result.rb +3 -2
  456. data/lib/dropbox_api/middleware/stack.rb +1 -0
  457. data/lib/dropbox_api/options_validator.rb +1 -0
  458. data/lib/dropbox_api/result_builder.rb +3 -2
  459. data/lib/dropbox_api/results/add_file_member_result_list.rb +1 -0
  460. data/lib/dropbox_api/results/base.rb +1 -0
  461. data/lib/dropbox_api/results/basic_account_batch.rb +1 -0
  462. data/lib/dropbox_api/results/copy_batch_result.rb +15 -0
  463. data/lib/dropbox_api/results/create_folder_batch_result.rb +21 -0
  464. data/lib/dropbox_api/results/create_folder_batch_result_entry.rb +20 -0
  465. data/lib/dropbox_api/results/delete_batch_result.rb +21 -0
  466. data/lib/dropbox_api/results/delete_batch_result_entry.rb +16 -0
  467. data/lib/dropbox_api/results/get_copy_reference_result.rb +4 -3
  468. data/lib/dropbox_api/results/get_temporary_link_result.rb +3 -2
  469. data/lib/dropbox_api/results/get_thumbnail_batch_result.rb +2 -1
  470. data/lib/dropbox_api/results/list_folder_get_latest_cursor_result.rb +2 -1
  471. data/lib/dropbox_api/results/list_folder_longpoll_result.rb +3 -2
  472. data/lib/dropbox_api/results/list_folder_result.rb +4 -3
  473. data/lib/dropbox_api/results/list_revisions_result.rb +3 -2
  474. data/lib/dropbox_api/results/list_shared_links_result.rb +4 -3
  475. data/lib/dropbox_api/results/relocation_batch_result.rb +21 -0
  476. data/lib/dropbox_api/results/relocation_batch_result_entry.rb +16 -0
  477. data/lib/dropbox_api/results/save_copy_reference_result.rb +2 -1
  478. data/lib/dropbox_api/results/save_url_job_status.rb +7 -6
  479. data/lib/dropbox_api/results/save_url_result.rb +2 -1
  480. data/lib/dropbox_api/results/search/match.rb +3 -2
  481. data/lib/dropbox_api/results/search_v2_result.rb +24 -0
  482. data/lib/dropbox_api/results/share_folder_launch.rb +4 -3
  483. data/lib/dropbox_api/results/shared_file_members.rb +5 -4
  484. data/lib/dropbox_api/results/shared_folder_members.rb +5 -4
  485. data/lib/dropbox_api/results/upload_session_start.rb +2 -1
  486. data/lib/dropbox_api/results/void_result.rb +1 -0
  487. data/lib/dropbox_api/version.rb +2 -1
  488. data/yardoc/endpoint_handler.rb +2 -1
  489. data/yardoc/helpers/html_helper.rb +2 -1
  490. data/yardoc/rspec.rb +3 -2
  491. data/yardoc/templates/default/method_details/setup.rb +1 -0
  492. metadata +330 -36
  493. data/CHANGES.md +0 -7
  494. data/lib/dropbox_api/results/search_result.rb +0 -22
@@ -0,0 +1,402 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: DropboxApi::Endpoints::Files::ListFolder
8
+
9
+ &mdash; Documentation by YARD 0.9.19
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "DropboxApi::Endpoints::Files::ListFolder";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (L)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
41
+ &raquo;
42
+ <span class="title">ListFolder</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: DropboxApi::Endpoints::Files::ListFolder
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
78
+
79
+ <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
80
+
81
+ <li class="next">DropboxApi::Endpoints::Files::ListFolder</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+ <dl>
95
+ <dt>Includes:</dt>
96
+ <dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
97
+ </dl>
98
+
99
+
100
+
101
+
102
+
103
+
104
+ <dl>
105
+ <dt>Defined in:</dt>
106
+ <dd>lib/dropbox_api/endpoints/files/list_folder.rb</dd>
107
+ </dl>
108
+
109
+ </div>
110
+
111
+
112
+
113
+ <h2>
114
+ Constant Summary
115
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
116
+ </h2>
117
+
118
+ <dl class="constants">
119
+
120
+ <dt id="Method-constant" class="">Method =
121
+
122
+ </dt>
123
+ <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
124
+
125
+ <dt id="Path-constant" class="">Path =
126
+
127
+ </dt>
128
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/2/files/list_folder</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
129
+
130
+ <dt id="ResultType-constant" class="">ResultType =
131
+
132
+ </dt>
133
+ <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListFolderResult.html" title="DropboxApi::Results::ListFolderResult (class)">ListFolderResult</a></span></span></pre></dd>
134
+
135
+ <dt id="ErrorType-constant" class="">ErrorType =
136
+
137
+ </dt>
138
+ <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListFolderError.html" title="DropboxApi::Errors::ListFolderError (class)">ListFolderError</a></span></span></pre></dd>
139
+
140
+ </dl>
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <h2>
151
+ Instance Method Summary
152
+ <small><a href="#" class="summary_toggle">collapse</a></small>
153
+ </h2>
154
+
155
+ <ul class="summary">
156
+
157
+ <li class="public ">
158
+ <span class="summary_signature">
159
+
160
+ <a href="#list_folder-instance_method" title="#list_folder (instance method)">#<strong>list_folder</strong>(path, options = {}) &#x21d2; Object </a>
161
+
162
+
163
+
164
+ </span>
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'><p>Returns the contents of a folder.</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ </ul>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
193
+ <p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
204
+ <p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
215
+ <p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
216
+ <div id="constructor_details" class="method_details_list">
217
+ <h2>Constructor Details</h2>
218
+
219
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
220
+
221
+ </div>
222
+
223
+
224
+ <div id="instance_method_details" class="method_details_list">
225
+ <h2>Instance Method Details</h2>
226
+
227
+
228
+ <div class="method_details first">
229
+ <h3 class="signature first" id="list_folder-instance_method">
230
+
231
+ #<strong>list_folder</strong>(path, options = {}) &#x21d2; <tt>Object</tt>
232
+
233
+
234
+
235
+
236
+
237
+ </h3><div class="docstring">
238
+ <div class="discussion">
239
+ <p>Returns the contents of a folder.</p>
240
+
241
+
242
+ </div>
243
+ </div>
244
+ <div class="tags">
245
+ <p class="tag_title">Parameters:</p>
246
+ <ul class="param">
247
+
248
+ <li>
249
+
250
+ <span class='name'>path</span>
251
+
252
+
253
+ <span class='type'>(<tt>String</tt>)</span>
254
+
255
+
256
+
257
+ &mdash;
258
+ <div class='inline'><p>The path to the folder you want to read.</p>
259
+ </div>
260
+
261
+ </li>
262
+
263
+ </ul>
264
+
265
+
266
+
267
+
268
+
269
+
270
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
271
+ <ul class="option">
272
+
273
+ <li>
274
+ <span class="name">recursive</span>
275
+ <span class="type">(<tt>Boolean</tt>)</span>
276
+ <span class="default">
277
+
278
+ </span>
279
+
280
+ &mdash; <div class='inline'><p>If <code>true</code>, the list folder operation
281
+ will be applied recursively to all subfolders and the response will
282
+ contain contents of all subfolders. The default for this field is
283
+ <code>false</code>.</p>
284
+ </div>
285
+
286
+ </li>
287
+
288
+ <li>
289
+ <span class="name">include_media_info</span>
290
+ <span class="type">(<tt>Boolean</tt>)</span>
291
+ <span class="default">
292
+
293
+ </span>
294
+
295
+ &mdash; <div class='inline'><p>If <code>true</code>, media_info
296
+ is set for photo and video. The default for this field is <code>false</code>.</p>
297
+ </div>
298
+
299
+ </li>
300
+
301
+ <li>
302
+ <span class="name">include_deleted</span>
303
+ <span class="type">(<tt>Boolean</tt>)</span>
304
+ <span class="default">
305
+
306
+ </span>
307
+
308
+ &mdash; <div class='inline'><p>If <code>true</code>,
309
+ <span class='object_link'><a href="../../Metadata/Deleted.html" title="DropboxApi::Metadata::Deleted (class)">Metadata::Deleted</a></span> will be
310
+ returned for deleted file or folder, otherwise
311
+ <span class='object_link'><a href="../../Errors/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">DropboxApi::Errors::NotFoundError</a></span>
312
+ will be raised. The default for this field is <code>false</code>.</p>
313
+ </div>
314
+
315
+ </li>
316
+
317
+ <li>
318
+ <span class="name">limit</span>
319
+ <span class="type">(<tt>Numeric</tt>)</span>
320
+ <span class="default">
321
+
322
+ </span>
323
+
324
+ &mdash; <div class='inline'><p>If present, will specify max number of
325
+ results per request (Note:
326
+ <a href="https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder" target="_parent" title="Dropbox docs">Dropbox docs</a> indicate
327
+ this is &quot;approximate&quot;, and more may be returned)</p>
328
+ </div>
329
+
330
+ </li>
331
+
332
+ </ul>
333
+
334
+
335
+
336
+ </div>
337
+ <table class="source_code">
338
+ <tr>
339
+ <td>
340
+ <pre class="lines">
341
+
342
+
343
+ 28
344
+ 29
345
+ 30
346
+ 31
347
+ 32
348
+ 33
349
+ 34
350
+ 35
351
+ 36
352
+ 37
353
+ 38
354
+ 39
355
+ 40
356
+ 41
357
+ 42
358
+ 43
359
+ 44
360
+ 45
361
+ 46</pre>
362
+ </td>
363
+ <td>
364
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder.rb', line 28</span>
365
+
366
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:list_folder</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='op'>|</span>
367
+ <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
368
+ <span class='symbol'>:recursive</span><span class='comma'>,</span>
369
+ <span class='symbol'>:include_media_info</span><span class='comma'>,</span>
370
+ <span class='symbol'>:include_deleted</span><span class='comma'>,</span>
371
+ <span class='symbol'>:shared_link</span><span class='comma'>,</span>
372
+ <span class='symbol'>:include_has_explicit_shared_members</span><span class='comma'>,</span>
373
+ <span class='symbol'>:limit</span>
374
+ <span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
375
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:recursive</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
376
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_media_info</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
377
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:include_deleted</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
378
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_build_shared_link_param'>build_shared_link_param</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:shared_link</span><span class='rbracket'>]</span>
379
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span>
380
+
381
+ <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
382
+ <span class='symbol'>:path</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_path'>path</span>
383
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
384
+ <span class='kw'>end</span></pre>
385
+ </td>
386
+ </tr>
387
+ </table>
388
+ </div>
389
+
390
+ </div>
391
+
392
+ </div>
393
+
394
+ <div id="footer">
395
+ Generated on Fri May 31 17:53:34 2019 by
396
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
397
+ 0.9.19 (ruby-2.6.2).
398
+ </div>
399
+
400
+ </div>
401
+ </body>
402
+ </html>
@@ -0,0 +1,298 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: DropboxApi::Endpoints::Files::ListFolderContinue
8
+
9
+ &mdash; Documentation by YARD 0.9.19
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "DropboxApi::Endpoints::Files::ListFolderContinue";
19
+ relpath = '../../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../../_index.html">Index (L)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
41
+ &raquo;
42
+ <span class="title">ListFolderContinue</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: DropboxApi::Endpoints::Files::ListFolderContinue
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
78
+
79
+ <li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
80
+
81
+ <li class="next">DropboxApi::Endpoints::Files::ListFolderContinue</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/dropbox_api/endpoints/files/list_folder_continue.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+
107
+
108
+ <h2>
109
+ Constant Summary
110
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
111
+ </h2>
112
+
113
+ <dl class="constants">
114
+
115
+ <dt id="Method-constant" class="">Method =
116
+ <div class="docstring">
117
+ <div class="discussion">
118
+ <p>NOTE: This hasn&#39;t been tested with real data, I couldn&#39;t make a query
119
+ long enough to enable the <code>has_more</code> attribute in the
120
+ <code>ListFolderResult</code>.</p>
121
+
122
+
123
+ </div>
124
+ </div>
125
+ <div class="tags">
126
+
127
+
128
+ </div>
129
+ </dt>
130
+ <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
131
+
132
+ <dt id="Path-constant" class="">Path =
133
+
134
+ </dt>
135
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/2/files/list_folder/continue</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
136
+
137
+ <dt id="ResultType-constant" class="">ResultType =
138
+
139
+ </dt>
140
+ <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/ListFolderResult.html" title="DropboxApi::Results::ListFolderResult (class)">ListFolderResult</a></span></span></pre></dd>
141
+
142
+ <dt id="ErrorType-constant" class="">ErrorType =
143
+
144
+ </dt>
145
+ <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/ListFolderContinueError.html" title="DropboxApi::Errors::ListFolderContinueError (class)">ListFolderContinueError</a></span></span></pre></dd>
146
+
147
+ </dl>
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+ <h2>
158
+ Instance Method Summary
159
+ <small><a href="#" class="summary_toggle">collapse</a></small>
160
+ </h2>
161
+
162
+ <ul class="summary">
163
+
164
+ <li class="public ">
165
+ <span class="summary_signature">
166
+
167
+ <a href="#list_folder_continue-instance_method" title="#list_folder_continue (instance method)">#<strong>list_folder_continue</strong>(cursor) &#x21d2; Object </a>
168
+
169
+
170
+
171
+ </span>
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+ <span class="summary_desc"><div class='inline'><p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate through all files and retrieve updates to the folder.</p>
182
+ </div></span>
183
+
184
+ </li>
185
+
186
+
187
+ </ul>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
200
+ <p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
211
+ <p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
212
+ <div id="constructor_details" class="method_details_list">
213
+ <h2>Constructor Details</h2>
214
+
215
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
216
+
217
+ </div>
218
+
219
+
220
+ <div id="instance_method_details" class="method_details_list">
221
+ <h2>Instance Method Details</h2>
222
+
223
+
224
+ <div class="method_details first">
225
+ <h3 class="signature first" id="list_folder_continue-instance_method">
226
+
227
+ #<strong>list_folder_continue</strong>(cursor) &#x21d2; <tt>Object</tt>
228
+
229
+
230
+
231
+
232
+
233
+ </h3><div class="docstring">
234
+ <div class="discussion">
235
+ <p>Once a cursor has been retrieved from <code>list_folder</code>, use this to paginate
236
+ through all files and retrieve updates to the folder.</p>
237
+
238
+
239
+ </div>
240
+ </div>
241
+ <div class="tags">
242
+ <p class="tag_title">Parameters:</p>
243
+ <ul class="param">
244
+
245
+ <li>
246
+
247
+ <span class='name'>cursor</span>
248
+
249
+
250
+ <span class='type'>(<tt>String</tt>)</span>
251
+
252
+
253
+
254
+ &mdash;
255
+ <div class='inline'><p>The cursor returned by your last call to
256
+ list_folder or list_folder_continue.</p>
257
+ </div>
258
+
259
+ </li>
260
+
261
+ </ul>
262
+
263
+
264
+ </div>
265
+ <table class="source_code">
266
+ <tr>
267
+ <td>
268
+ <pre class="lines">
269
+
270
+
271
+ 16
272
+ 17
273
+ 18</pre>
274
+ </td>
275
+ <td>
276
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/list_folder_continue.rb', line 16</span>
277
+
278
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:list_folder_continue</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_cursor'>cursor</span><span class='op'>|</span>
279
+ <span class='id identifier rubyid_perform_request'>perform_request</span> <span class='symbol'>:cursor</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_cursor'>cursor</span>
280
+ <span class='kw'>end</span></pre>
281
+ </td>
282
+ </tr>
283
+ </table>
284
+ </div>
285
+
286
+ </div>
287
+
288
+ </div>
289
+
290
+ <div id="footer">
291
+ Generated on Fri May 31 17:53:36 2019 by
292
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
293
+ 0.9.19 (ruby-2.6.2).
294
+ </div>
295
+
296
+ </div>
297
+ </body>
298
+ </html>