dropbox_api 0.1.17 → 0.1.18
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.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/docs/DropboxApi.html +4 -4
- data/docs/DropboxApi/Authenticator.html +3 -3
- data/docs/DropboxApi/ChunkedUploader.html +3 -3
- data/docs/DropboxApi/Client.html +1261 -88
- data/docs/DropboxApi/ConnectionBuilder.html +3 -3
- data/docs/DropboxApi/Endpoints.html +3 -3
- data/docs/DropboxApi/Endpoints/Auth.html +3 -3
- data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +3 -3
- data/docs/DropboxApi/Endpoints/Base.html +3 -3
- data/docs/DropboxApi/Endpoints/ContentDownload.html +3 -3
- data/docs/DropboxApi/Endpoints/ContentUpload.html +3 -3
- data/docs/DropboxApi/Endpoints/Files.html +5 -5
- data/docs/DropboxApi/Endpoints/Files/Copy.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/CopyBatch.html +359 -0
- data/docs/DropboxApi/Endpoints/Files/CopyBatchCheck.html +305 -0
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +5 -5
- data/docs/DropboxApi/Endpoints/Files/CreateFolder.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/CreateFolderBatch.html +377 -0
- data/docs/DropboxApi/Endpoints/Files/CreateFolderBatchCheck.html +308 -0
- data/docs/DropboxApi/Endpoints/Files/Delete.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/DeleteBatch.html +305 -0
- data/docs/DropboxApi/Endpoints/Files/DeleteBatchCheck.html +307 -0
- data/docs/DropboxApi/Endpoints/Files/Download.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/GetMetadata.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/GetPreview.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/GetThumbnail.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/ListFolder.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/ListRevisions.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/Move.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/Restore.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/SaveUrl.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/Search.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/Upload.html +4 -4
- data/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +3 -3
- data/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +3 -3
- data/docs/DropboxApi/Endpoints/Rpc.html +4 -4
- data/docs/DropboxApi/Endpoints/RpcContent.html +3 -3
- data/docs/DropboxApi/Endpoints/RpcNotify.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +4 -4
- data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/RevokeSharedLink.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/ShareFolder.html +3 -3
- data/docs/DropboxApi/Endpoints/Sharing/UnshareFile.html +3 -3
- data/docs/DropboxApi/Endpoints/Users.html +3 -3
- data/docs/DropboxApi/Endpoints/Users/GetAccount.html +3 -3
- data/docs/DropboxApi/Endpoints/Users/GetAccountBatch.html +3 -3
- data/docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html +3 -3
- data/docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html +3 -3
- data/docs/DropboxApi/Errors.html +5 -5
- data/docs/DropboxApi/Errors/AddFileMemberError.html +3 -3
- data/docs/DropboxApi/Errors/AddFolderMemberError.html +3 -3
- data/docs/DropboxApi/Errors/AddMemberSelectorError.html +3 -3
- data/docs/DropboxApi/Errors/AlreadySharedError.html +3 -3
- data/docs/DropboxApi/Errors/BadPathError.html +3 -3
- data/docs/DropboxApi/Errors/BasicError.html +4 -4
- data/docs/DropboxApi/Errors/CantCopySharedFolderError.html +3 -3
- data/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +3 -3
- data/docs/DropboxApi/Errors/CantNestSharedFolderError.html +3 -3
- data/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +3 -3
- data/docs/DropboxApi/Errors/ContainsSharedFolderError.html +3 -3
- data/docs/DropboxApi/Errors/ConversionError.html +3 -3
- data/docs/DropboxApi/Errors/CreateFileRequestError.html +3 -3
- data/docs/DropboxApi/Errors/CreateFolderBatchError.html +161 -0
- data/docs/DropboxApi/Errors/CreateFolderError.html +3 -3
- data/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +3 -3
- data/docs/DropboxApi/Errors/CursorClosedError.html +3 -3
- data/docs/DropboxApi/Errors/CursorNotClosedError.html +3 -3
- data/docs/DropboxApi/Errors/DeleteError.html +5 -4
- data/docs/DropboxApi/Errors/DisallowedNameError.html +3 -3
- data/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +3 -3
- data/docs/DropboxApi/Errors/DownloadError.html +3 -3
- data/docs/DropboxApi/Errors/DownloadFailedError.html +3 -3
- data/docs/DropboxApi/Errors/EmailUnverifiedError.html +3 -3
- data/docs/DropboxApi/Errors/FileAncestorConflictError.html +3 -3
- data/docs/DropboxApi/Errors/FileConflictError.html +3 -3
- data/docs/DropboxApi/Errors/FileMemberActionError.html +3 -3
- data/docs/DropboxApi/Errors/FolderConflictError.html +3 -3
- data/docs/DropboxApi/Errors/GetAccountError.html +3 -3
- data/docs/DropboxApi/Errors/GetCopyReferenceError.html +3 -3
- data/docs/DropboxApi/Errors/GetMetadataError.html +3 -3
- data/docs/DropboxApi/Errors/GroupDeletedError.html +3 -3
- data/docs/DropboxApi/Errors/GroupNotOnTeamError.html +3 -3
- data/docs/DropboxApi/Errors/HttpError.html +3 -3
- data/docs/DropboxApi/Errors/InProgressError.html +3 -3
- data/docs/DropboxApi/Errors/InsideAppFolderError.html +3 -3
- data/docs/DropboxApi/Errors/InsideOsxPackageError.html +3 -3
- data/docs/DropboxApi/Errors/InsidePublicFolderError.html +3 -3
- data/docs/DropboxApi/Errors/InsideSharedFolderError.html +3 -3
- data/docs/DropboxApi/Errors/InsufficientPlanError.html +3 -3
- data/docs/DropboxApi/Errors/InsufficientSpaceError.html +3 -3
- data/docs/DropboxApi/Errors/InternalError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidCommentError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidCursorError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidDropboxIdError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidEmailError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidFileError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidIdError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidMemberError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidPathError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidRevisionError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidSettingsError.html +3 -3
- data/docs/DropboxApi/Errors/InvalidUrlError.html +3 -3
- data/docs/DropboxApi/Errors/IsAppFolderError.html +3 -3
- data/docs/DropboxApi/Errors/IsFileError.html +3 -3
- data/docs/DropboxApi/Errors/IsFolderError.html +3 -3
- data/docs/DropboxApi/Errors/IsOsxPackageError.html +3 -3
- data/docs/DropboxApi/Errors/IsPublicFolderError.html +3 -3
- data/docs/DropboxApi/Errors/ListFolderContinueError.html +3 -3
- data/docs/DropboxApi/Errors/ListFolderError.html +3 -3
- data/docs/DropboxApi/Errors/ListFolderLongpollError.html +3 -3
- data/docs/DropboxApi/Errors/ListRevisionsError.html +3 -3
- data/docs/DropboxApi/Errors/ListSharedLinksError.html +3 -3
- data/docs/DropboxApi/Errors/LookupError.html +3 -3
- data/docs/DropboxApi/Errors/MalformedPathError.html +3 -3
- data/docs/DropboxApi/Errors/NoAccountError.html +3 -3
- data/docs/DropboxApi/Errors/NoPermissionError.html +3 -3
- data/docs/DropboxApi/Errors/NoWritePermissionError.html +3 -3
- data/docs/DropboxApi/Errors/NotAMemberError.html +3 -3
- data/docs/DropboxApi/Errors/NotFileError.html +3 -3
- data/docs/DropboxApi/Errors/NotFolderError.html +3 -3
- data/docs/DropboxApi/Errors/NotFoundError.html +3 -3
- data/docs/DropboxApi/Errors/PollError.html +3 -3
- data/docs/DropboxApi/Errors/PreviewError.html +3 -3
- data/docs/DropboxApi/Errors/RateLimitError.html +3 -3
- data/docs/DropboxApi/Errors/RelocationBatchEntryError.html +163 -0
- data/docs/DropboxApi/Errors/RelocationError.html +3 -3
- data/docs/DropboxApi/Errors/RestoreError.html +3 -3
- data/docs/DropboxApi/Errors/RestrictedContentError.html +3 -3
- data/docs/DropboxApi/Errors/RevokeSharedLinkError.html +3 -3
- data/docs/DropboxApi/Errors/SaveCopyReferenceError.html +3 -3
- data/docs/DropboxApi/Errors/SaveUrlError.html +3 -3
- data/docs/DropboxApi/Errors/SearchError.html +3 -3
- data/docs/DropboxApi/Errors/SettingsError.html +3 -3
- data/docs/DropboxApi/Errors/ShareFolderError.html +3 -3
- data/docs/DropboxApi/Errors/SharePathError.html +3 -3
- data/docs/DropboxApi/Errors/SharedFolderAccessError.html +3 -3
- data/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +3 -3
- data/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +3 -3
- data/docs/DropboxApi/Errors/SharedLinkError.html +3 -3
- data/docs/DropboxApi/Errors/SharedLinkMalformedError.html +3 -3
- data/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +3 -3
- data/docs/DropboxApi/Errors/SharingFileAccessError.html +3 -3
- data/docs/DropboxApi/Errors/SharingUserError.html +3 -3
- data/docs/DropboxApi/Errors/TeamFolderError.html +3 -3
- data/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +3 -3
- data/docs/DropboxApi/Errors/ThumbnailBatchError.html +3 -3
- data/docs/DropboxApi/Errors/ThumbnailError.html +3 -3
- data/docs/DropboxApi/Errors/TooManyFilesError.html +3 -3
- data/docs/DropboxApi/Errors/TooManyMembersError.html +3 -3
- data/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +3 -3
- data/docs/DropboxApi/Errors/TooManyRequestsError.html +3 -3
- data/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +3 -3
- data/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +3 -3
- data/docs/DropboxApi/Errors/UnmountedError.html +3 -3
- data/docs/DropboxApi/Errors/UnshareFileError.html +3 -3
- data/docs/DropboxApi/Errors/UnsupportedContentError.html +3 -3
- data/docs/DropboxApi/Errors/UnsupportedExtensionError.html +3 -3
- data/docs/DropboxApi/Errors/UnsupportedImageError.html +3 -3
- data/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +3 -3
- data/docs/DropboxApi/Errors/UnverifiedDropboxId.html +3 -3
- data/docs/DropboxApi/Errors/UploadError.html +3 -3
- data/docs/DropboxApi/Errors/UploadSessionFinishError.html +3 -3
- data/docs/DropboxApi/Errors/UploadSessionLookupError.html +3 -3
- data/docs/DropboxApi/Errors/UploadSessionOffsetError.html +3 -3
- data/docs/DropboxApi/Errors/UploadWriteFailedError.html +3 -3
- data/docs/DropboxApi/Errors/WriteConflictError.html +3 -3
- data/docs/DropboxApi/Errors/WriteError.html +3 -3
- data/docs/DropboxApi/Metadata.html +3 -3
- data/docs/DropboxApi/Metadata/AccessLevel.html +3 -3
- data/docs/DropboxApi/Metadata/AddFileMemberResult.html +3 -3
- data/docs/DropboxApi/Metadata/AddMember.html +3 -3
- data/docs/DropboxApi/Metadata/Base.html +3 -3
- data/docs/DropboxApi/Metadata/BasicAccount.html +3 -3
- data/docs/DropboxApi/Metadata/CommitInfo.html +3 -3
- data/docs/DropboxApi/Metadata/Deleted.html +3 -3
- data/docs/DropboxApi/Metadata/Dimensions.html +3 -3
- data/docs/DropboxApi/Metadata/Field.html +3 -3
- data/docs/DropboxApi/Metadata/File.html +3 -3
- data/docs/DropboxApi/Metadata/FileLinkMetadata.html +3 -3
- data/docs/DropboxApi/Metadata/FileMemberAction.html +3 -3
- data/docs/DropboxApi/Metadata/FileRequest.html +3 -3
- data/docs/DropboxApi/Metadata/Folder.html +3 -3
- data/docs/DropboxApi/Metadata/FolderLinkMetadata.html +3 -3
- data/docs/DropboxApi/Metadata/FolderSharingInfo.html +3 -3
- data/docs/DropboxApi/Metadata/LinkPermissions.html +3 -3
- data/docs/DropboxApi/Metadata/Location.html +3 -3
- data/docs/DropboxApi/Metadata/MediaInfo.html +3 -3
- data/docs/DropboxApi/Metadata/MediaMetadata.html +3 -3
- data/docs/DropboxApi/Metadata/Member.html +3 -3
- data/docs/DropboxApi/Metadata/MemberAction.html +3 -3
- data/docs/DropboxApi/Metadata/MemberActionList.html +3 -3
- data/docs/DropboxApi/Metadata/MemberPermission.html +3 -3
- data/docs/DropboxApi/Metadata/MemberPermissionList.html +3 -3
- data/docs/DropboxApi/Metadata/Name.html +3 -3
- data/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +3 -3
- data/docs/DropboxApi/Metadata/PhotoMetadata.html +3 -3
- data/docs/DropboxApi/Metadata/Resource.html +3 -3
- data/docs/DropboxApi/Metadata/SharedFolder.html +3 -3
- data/docs/DropboxApi/Metadata/SharedFolderPolicy.html +3 -3
- data/docs/DropboxApi/Metadata/SharedLink.html +3 -3
- data/docs/DropboxApi/Metadata/SharedLinkMetadata.html +3 -3
- data/docs/DropboxApi/Metadata/SpaceAllocation.html +3 -3
- data/docs/DropboxApi/Metadata/SpaceUsage.html +3 -3
- data/docs/DropboxApi/Metadata/Tag.html +3 -3
- data/docs/DropboxApi/Metadata/Team.html +3 -3
- data/docs/DropboxApi/Metadata/TeamMemberInfo.html +3 -3
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +3 -3
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +3 -3
- data/docs/DropboxApi/Metadata/UploadSessionCursor.html +3 -3
- data/docs/DropboxApi/Metadata/VideoMetadata.html +3 -3
- data/docs/DropboxApi/Metadata/WriteMode.html +3 -3
- data/docs/DropboxApi/MiddleWare.html +3 -3
- data/docs/DropboxApi/MiddleWare/DecodeResult.html +3 -3
- data/docs/DropboxApi/MiddleWare/Stack.html +3 -3
- data/docs/DropboxApi/OptionsValidator.html +4 -4
- data/docs/DropboxApi/ResultBuilder.html +3 -3
- data/docs/DropboxApi/Results.html +5 -5
- data/docs/DropboxApi/Results/AddFileMemberResultList.html +3 -3
- data/docs/DropboxApi/Results/Base.html +4 -4
- data/docs/DropboxApi/Results/BasicAccountBatch.html +3 -3
- data/docs/DropboxApi/Results/CopyBatchResult.html +224 -0
- data/docs/DropboxApi/Results/CreateFolderBatchResult.html +241 -0
- data/docs/DropboxApi/Results/CreateFolderBatchResultEntry.html +234 -0
- data/docs/DropboxApi/Results/DeleteBatchResult.html +241 -0
- data/docs/DropboxApi/Results/DeleteBatchResultEntry.html +226 -0
- data/docs/DropboxApi/Results/GetCopyReferenceResult.html +3 -3
- data/docs/DropboxApi/Results/GetTemporaryLinkResult.html +3 -3
- data/docs/DropboxApi/Results/GetThumbnailBatchResult.html +3 -3
- data/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +3 -3
- data/docs/DropboxApi/Results/ListFolderLongpollResult.html +3 -3
- data/docs/DropboxApi/Results/ListFolderResult.html +3 -3
- data/docs/DropboxApi/Results/ListRevisionsResult.html +3 -3
- data/docs/DropboxApi/Results/ListSharedLinksResult.html +3 -3
- data/docs/DropboxApi/Results/RelocationBatchResult.html +241 -0
- data/docs/DropboxApi/Results/RelocationBatchResultEntry.html +226 -0
- data/docs/DropboxApi/Results/SaveCopyReferenceResult.html +3 -3
- data/docs/DropboxApi/Results/SaveUrlJobStatus.html +3 -3
- data/docs/DropboxApi/Results/SaveUrlResult.html +3 -3
- data/docs/DropboxApi/Results/Search.html +3 -3
- data/docs/DropboxApi/Results/Search/Match.html +3 -3
- data/docs/DropboxApi/Results/SearchResult.html +3 -3
- data/docs/DropboxApi/Results/ShareFolderLaunch.html +3 -3
- data/docs/DropboxApi/Results/SharedFileMembers.html +3 -3
- data/docs/DropboxApi/Results/SharedFolderMembers.html +3 -3
- data/docs/DropboxApi/Results/UploadSessionStart.html +3 -3
- data/docs/DropboxApi/Results/VoidResult.html +3 -3
- data/docs/DropboxScaffoldBuilder.html +105 -50
- data/docs/_index.html +123 -18
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +3 -3
- data/docs/file.api_coverage.html +10 -10
- data/docs/file.rails_setup.html +3 -3
- data/docs/frames.html +1 -1
- data/docs/index.html +3 -3
- data/docs/js/app.js +11 -0
- data/docs/method_list.html +417 -257
- data/docs/top-level-namespace.html +3 -3
- data/dropbox_api.gemspec +1 -1
- data/lib/dropbox_api/version.rb +1 -1
- metadata +20 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8a3a1a2bc289cebba02099f33f564a26f5534a2103621f8533e1eec22fd12ad6
|
|
4
|
+
data.tar.gz: b1a9743de1947243db1a0cb17da1d410dcb61a9b196c80ed9fe5f8c617bb7067
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5c691510ae44d46099d87cf75d822381fe006ae9b77f45b4c08a6f0d7b2db884c6fdf504acf2df930c344ee0b19b664b4fa6b726c15c21c7117452a8dfcd5c13
|
|
7
|
+
data.tar.gz: 047bb7cf238a161d4572d23b126c9ba50b35ffaf9a588a2846c613a5c4b317df11e94fb1c16f91a74d30093f37b8452d6ff15c5fbee46b7a2465b93dec28e4b5
|
data/Gemfile
CHANGED
|
@@ -5,7 +5,7 @@ gemspec
|
|
|
5
5
|
group :development do
|
|
6
6
|
# Documentation
|
|
7
7
|
gem 'redcarpet'
|
|
8
|
-
gem 'yard-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
|
|
8
|
+
gem 'yard-tests-rspec', :git => "https://github.com/Jesus/yard-spec-plugin.git"
|
|
9
9
|
|
|
10
10
|
# Code linting
|
|
11
11
|
gem 'rubocop', :require => false
|
data/docs/DropboxApi.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Module: DropboxApi
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.19
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<dt id="VERSION-constant" class="">VERSION =
|
|
110
110
|
|
|
111
111
|
</dt>
|
|
112
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.
|
|
112
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0.1.17</span><span class='tstring_end'>'</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
113
113
|
|
|
114
114
|
</dl>
|
|
115
115
|
|
|
@@ -125,9 +125,9 @@
|
|
|
125
125
|
</div>
|
|
126
126
|
|
|
127
127
|
<div id="footer">
|
|
128
|
-
Generated on
|
|
128
|
+
Generated on Fri May 31 17:53:31 2019 by
|
|
129
129
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
130
|
-
0.9.
|
|
130
|
+
0.9.19 (ruby-2.6.2).
|
|
131
131
|
</div>
|
|
132
132
|
|
|
133
133
|
</div>
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: DropboxApi::Authenticator
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.19
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -207,9 +207,9 @@
|
|
|
207
207
|
</div>
|
|
208
208
|
|
|
209
209
|
<div id="footer">
|
|
210
|
-
Generated on
|
|
210
|
+
Generated on Fri May 31 17:53:32 2019 by
|
|
211
211
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
212
|
-
0.9.
|
|
212
|
+
0.9.19 (ruby-2.6.2).
|
|
213
213
|
</div>
|
|
214
214
|
|
|
215
215
|
</div>
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: DropboxApi::ChunkedUploader
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.19
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -401,9 +401,9 @@
|
|
|
401
401
|
</div>
|
|
402
402
|
|
|
403
403
|
<div id="footer">
|
|
404
|
-
Generated on
|
|
404
|
+
Generated on Fri May 31 17:53:32 2019 by
|
|
405
405
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
406
|
-
0.9.
|
|
406
|
+
0.9.19 (ruby-2.6.2).
|
|
407
407
|
</div>
|
|
408
408
|
|
|
409
409
|
</div>
|
data/docs/DropboxApi/Client.html
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: DropboxApi::Client
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.19
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -407,6 +407,52 @@
|
|
|
407
407
|
<span class="summary_desc"><div class='inline'><p>Copy a file or folder to a different location in the user's Dropbox.</p>
|
|
408
408
|
</div></span>
|
|
409
409
|
|
|
410
|
+
</li>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
<li class="public ">
|
|
414
|
+
<span class="summary_signature">
|
|
415
|
+
|
|
416
|
+
<a href="#copy_batch-instance_method" title="#copy_batch (instance method)">#<strong>copy_batch</strong>(entries, options = {}) ⇒ String, Array </a>
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
</span>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
<span class="summary_desc"><div class='inline'><p>Copy multiple files or folders to different locations at once in the user's Dropbox.</p>
|
|
431
|
+
</div></span>
|
|
432
|
+
|
|
433
|
+
</li>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<li class="public ">
|
|
437
|
+
<span class="summary_signature">
|
|
438
|
+
|
|
439
|
+
<a href="#copy_batch_check-instance_method" title="#copy_batch_check (instance method)">#<strong>copy_batch_check</strong>(async_job_id) ⇒ :in_progress, Array </a>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
</span>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
<span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>.</p>
|
|
454
|
+
</div></span>
|
|
455
|
+
|
|
410
456
|
</li>
|
|
411
457
|
|
|
412
458
|
|
|
@@ -499,6 +545,52 @@
|
|
|
499
545
|
<span class="summary_desc"><div class='inline'><p>Create a folder at a given path.</p>
|
|
500
546
|
</div></span>
|
|
501
547
|
|
|
548
|
+
</li>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<li class="public ">
|
|
552
|
+
<span class="summary_signature">
|
|
553
|
+
|
|
554
|
+
<a href="#create_folder_batch-instance_method" title="#create_folder_batch (instance method)">#<strong>create_folder_batch</strong>(paths, options = {}) ⇒ String, Array </a>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
</span>
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
<span class="summary_desc"><div class='inline'><p>Create multiple folders at once.</p>
|
|
569
|
+
</div></span>
|
|
570
|
+
|
|
571
|
+
</li>
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
<li class="public ">
|
|
575
|
+
<span class="summary_signature">
|
|
576
|
+
|
|
577
|
+
<a href="#create_folder_batch_check-instance_method" title="#create_folder_batch_check (instance method)">#<strong>create_folder_batch_check</strong>(async_job_id) ⇒ Array </a>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
</span>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
<span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for create_folder_batch.</p>
|
|
592
|
+
</div></span>
|
|
593
|
+
|
|
502
594
|
</li>
|
|
503
595
|
|
|
504
596
|
|
|
@@ -522,6 +614,52 @@
|
|
|
522
614
|
<span class="summary_desc"><div class='inline'><p>Delete the file or folder at a given path.</p>
|
|
523
615
|
</div></span>
|
|
524
616
|
|
|
617
|
+
</li>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
<li class="public ">
|
|
621
|
+
<span class="summary_signature">
|
|
622
|
+
|
|
623
|
+
<a href="#delete_batch-instance_method" title="#delete_batch (instance method)">#<strong>delete_batch</strong>(entries) ⇒ String, Array </a>
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
</span>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
<span class="summary_desc"><div class='inline'><p>Delete multiple files/folders at once.</p>
|
|
638
|
+
</div></span>
|
|
639
|
+
|
|
640
|
+
</li>
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
<li class="public ">
|
|
644
|
+
<span class="summary_signature">
|
|
645
|
+
|
|
646
|
+
<a href="#delete_batch_check-instance_method" title="#delete_batch_check (instance method)">#<strong>delete_batch_check</strong>(async_job_id) ⇒ :in_progress, Array </a>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
</span>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
<span class="summary_desc"><div class='inline'><p>Returns the status of an asynchronous job for delete_batch.</p>
|
|
661
|
+
</div></span>
|
|
662
|
+
|
|
525
663
|
</li>
|
|
526
664
|
|
|
527
665
|
|
|
@@ -1448,7 +1586,7 @@ display to added members in their invitation. This field is optional.</p>
|
|
|
1448
1586
|
<pre class="code"><span class="info file"># File 'spec/endpoints/sharing/add_file_member_spec.rb', line 33</span>
|
|
1449
1587
|
|
|
1450
1588
|
<span class='id identifier rubyid_file'>file</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/bsd.pdf</span><span class='tstring_end'>"</span></span>
|
|
1451
|
-
<span class='id identifier rubyid_members'>members</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_file_member'>add_file_member</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>a@test.com</span><span class='words_sep'> </span><span class='tstring_content'>b@test.com</span><span class='
|
|
1589
|
+
<span class='id identifier rubyid_members'>members</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_add_file_member'>add_file_member</span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='qwords_beg'>%w(</span><span class='tstring_content'>a@test.com</span><span class='words_sep'> </span><span class='tstring_content'>b@test.com</span><span class='tstring_end'>)</span></span><span class='rparen'>)</span>
|
|
1452
1590
|
|
|
1453
1591
|
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
|
|
1454
1592
|
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><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/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</a></span></span><span class='rparen'>)</span>
|
|
@@ -2023,9 +2161,9 @@ If the source path is a folder all its contents will be copied.</p>
|
|
|
2023
2161
|
</div>
|
|
2024
2162
|
|
|
2025
2163
|
<div class="method_details ">
|
|
2026
|
-
<h3 class="signature " id="
|
|
2164
|
+
<h3 class="signature " id="copy_batch-instance_method">
|
|
2027
2165
|
|
|
2028
|
-
#<strong>
|
|
2166
|
+
#<strong>copy_batch</strong>(entries, options = {}) ⇒ <tt>String</tt>, <tt>Array</tt>
|
|
2029
2167
|
|
|
2030
2168
|
|
|
2031
2169
|
|
|
@@ -2033,9 +2171,14 @@ If the source path is a folder all its contents will be copied.</p>
|
|
|
2033
2171
|
|
|
2034
2172
|
</h3><div class="docstring">
|
|
2035
2173
|
<div class="discussion">
|
|
2036
|
-
<p>
|
|
2037
|
-
|
|
2038
|
-
|
|
2174
|
+
<p>Copy multiple files or folders to different locations at once in the
|
|
2175
|
+
user's Dropbox.</p>
|
|
2176
|
+
|
|
2177
|
+
<p>This will either finish synchronously, or return a job ID and do
|
|
2178
|
+
the async copy job in background. Please use <span class='object_link'><a href="#copy_batch_check-instance_method" title="DropboxApi::Client#copy_batch_check (method)">#copy_batch_check</a></span>
|
|
2179
|
+
to check the job status.</p>
|
|
2180
|
+
|
|
2181
|
+
<p>Note: No errors are returned by this endpoint.</p>
|
|
2039
2182
|
|
|
2040
2183
|
|
|
2041
2184
|
</div>
|
|
@@ -2046,56 +2189,164 @@ to another user's Dropbox by passing it to <span class='object_link'><a href
|
|
|
2046
2189
|
|
|
2047
2190
|
<li>
|
|
2048
2191
|
|
|
2049
|
-
<span class='name'>
|
|
2192
|
+
<span class='name'>entries</span>
|
|
2050
2193
|
|
|
2051
2194
|
|
|
2052
|
-
<span class='type'>(<tt>
|
|
2195
|
+
<span class='type'>(<tt>Array<Hash></tt>)</span>
|
|
2053
2196
|
|
|
2054
2197
|
|
|
2055
2198
|
|
|
2056
2199
|
—
|
|
2057
|
-
<div class='inline'><p>
|
|
2058
|
-
|
|
2200
|
+
<div class='inline'><p>List of entries to be moved or copied.
|
|
2201
|
+
Each entry must be a hash with two keys: <code>:from_path</code> & <code>:to_path</code>.</p>
|
|
2059
2202
|
</div>
|
|
2060
2203
|
|
|
2061
2204
|
</li>
|
|
2062
2205
|
|
|
2063
2206
|
</ul>
|
|
2064
2207
|
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
2214
|
+
<ul class="option">
|
|
2215
|
+
|
|
2216
|
+
<li>
|
|
2217
|
+
<span class="name">autorename</span>
|
|
2218
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
2219
|
+
<span class="default">
|
|
2220
|
+
|
|
2221
|
+
</span>
|
|
2222
|
+
|
|
2223
|
+
— <div class='inline'><p>If there's a conflict with any file,
|
|
2224
|
+
have the Dropbox server try to autorename that file to avoid the
|
|
2225
|
+
conflict. The default for this field is <code>false</code>.</p>
|
|
2226
|
+
</div>
|
|
2227
|
+
|
|
2228
|
+
</li>
|
|
2229
|
+
|
|
2230
|
+
</ul>
|
|
2231
|
+
|
|
2232
|
+
|
|
2065
2233
|
<p class="tag_title">Returns:</p>
|
|
2066
2234
|
<ul class="return">
|
|
2067
2235
|
|
|
2068
2236
|
<li>
|
|
2069
2237
|
|
|
2070
2238
|
|
|
2071
|
-
<span class='type'>(<tt
|
|
2239
|
+
<span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
|
|
2072
2240
|
|
|
2073
2241
|
|
|
2074
2242
|
|
|
2243
|
+
—
|
|
2244
|
+
<div class='inline'><p>Either the job id or the list of job statuses.</p>
|
|
2245
|
+
</div>
|
|
2246
|
+
|
|
2075
2247
|
</li>
|
|
2076
2248
|
|
|
2077
2249
|
</ul>
|
|
2078
2250
|
|
|
2079
2251
|
</div>
|
|
2252
|
+
<div class="tags">
|
|
2253
|
+
<p class="tag_title">Specifications:</p>
|
|
2254
|
+
<ul class="specs">
|
|
2255
|
+
|
|
2256
|
+
<li>
|
|
2257
|
+
returns an async job id
|
|
2258
|
+
<table class="source_code test_code">
|
|
2259
|
+
<tr>
|
|
2260
|
+
<td>
|
|
2261
|
+
<pre class="lines">
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
7
|
|
2265
|
+
8
|
|
2266
|
+
9
|
|
2267
|
+
10
|
|
2268
|
+
11
|
|
2269
|
+
12
|
|
2270
|
+
13</pre>
|
|
2271
|
+
</td>
|
|
2272
|
+
<td>
|
|
2273
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 24</span>
|
|
2274
|
+
|
|
2275
|
+
<span class='id identifier rubyid_job_id'>job_id</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch'>copy_batch</span> <span class='lbracket'>[</span><span class='lbrace'>{</span>
|
|
2276
|
+
<span class='symbol'>:from_path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file.txt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
2277
|
+
<span class='symbol'>:to_path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_renamed.txt</span><span class='tstring_end'>"</span></span>
|
|
2278
|
+
<span class='rbrace'>}</span><span class='rbracket'>]</span>
|
|
2279
|
+
|
|
2280
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span>
|
|
2281
|
+
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AAA6b4uwc19nEau5k-OBI_h-hjrR7pNDaUA3_0hOwV-UZ2pkw_zXWp3FSuVZrQ0d9IXKGkwB5JdYI4mJZumLc6qZ</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></pre>
|
|
2282
|
+
</td>
|
|
2283
|
+
</tr>
|
|
2284
|
+
</table>
|
|
2285
|
+
</li>
|
|
2286
|
+
|
|
2287
|
+
<li>
|
|
2288
|
+
if autorename option is true, returns an async job id
|
|
2289
|
+
<table class="source_code test_code">
|
|
2290
|
+
<tr>
|
|
2291
|
+
<td>
|
|
2292
|
+
<pre class="lines">
|
|
2293
|
+
|
|
2294
|
+
|
|
2295
|
+
17
|
|
2296
|
+
18
|
|
2297
|
+
19
|
|
2298
|
+
20
|
|
2299
|
+
21
|
|
2300
|
+
22
|
|
2301
|
+
23</pre>
|
|
2302
|
+
</td>
|
|
2303
|
+
<td>
|
|
2304
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_spec.rb', line 24</span>
|
|
2305
|
+
|
|
2306
|
+
<span class='id identifier rubyid_job_id'>job_id</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch'>copy_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='lbrace'>{</span>
|
|
2307
|
+
<span class='symbol'>:from_path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2.txt</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
2308
|
+
<span class='symbol'>:to_path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/regular_file_2_renamed.txt</span><span class='tstring_end'>"</span></span>
|
|
2309
|
+
<span class='rbrace'>}</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:autorename</span> <span class='op'>=></span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
2310
|
+
|
|
2311
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_job_id'>job_id</span><span class='rparen'>)</span>
|
|
2312
|
+
<span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_eq'>eq</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AABe-bOUUq5nrybciMJxIxaGAD16nGCKByGyY3Z_2m6kshGW903XTikVT3_5V6JQQu20p3QxoCfws7_hT40deF6q</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></pre>
|
|
2313
|
+
</td>
|
|
2314
|
+
</tr>
|
|
2315
|
+
</table>
|
|
2316
|
+
</li>
|
|
2317
|
+
|
|
2318
|
+
</ul>
|
|
2319
|
+
</div>
|
|
2320
|
+
|
|
2080
2321
|
<table class="source_code">
|
|
2081
2322
|
<tr>
|
|
2082
2323
|
<td>
|
|
2083
2324
|
<pre class="lines">
|
|
2084
2325
|
|
|
2085
2326
|
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2327
|
+
24
|
|
2328
|
+
25
|
|
2329
|
+
26
|
|
2330
|
+
27
|
|
2331
|
+
28
|
|
2332
|
+
29
|
|
2333
|
+
30
|
|
2334
|
+
31
|
|
2335
|
+
32
|
|
2336
|
+
33</pre>
|
|
2091
2337
|
</td>
|
|
2092
2338
|
<td>
|
|
2093
|
-
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/
|
|
2339
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch.rb', line 24</span>
|
|
2094
2340
|
|
|
2095
|
-
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:
|
|
2096
|
-
<span class='id identifier
|
|
2097
|
-
<span class='symbol'>:
|
|
2098
|
-
<span class='
|
|
2341
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy_batch</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entries'>entries</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>
|
|
2342
|
+
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
|
|
2343
|
+
<span class='symbol'>:autorename</span>
|
|
2344
|
+
<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
2345
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
|
|
2346
|
+
|
|
2347
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</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>
|
|
2348
|
+
<span class='symbol'>:entries</span> <span class='op'>=></span> <span class='id identifier rubyid_entries'>entries</span>
|
|
2349
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
2099
2350
|
<span class='kw'>end</span></pre>
|
|
2100
2351
|
</td>
|
|
2101
2352
|
</tr>
|
|
@@ -2103,9 +2354,9 @@ copy reference to.</p>
|
|
|
2103
2354
|
</div>
|
|
2104
2355
|
|
|
2105
2356
|
<div class="method_details ">
|
|
2106
|
-
<h3 class="signature " id="
|
|
2357
|
+
<h3 class="signature " id="copy_batch_check-instance_method">
|
|
2107
2358
|
|
|
2108
|
-
#<strong>
|
|
2359
|
+
#<strong>copy_batch_check</strong>(async_job_id) ⇒ <tt>:in_progress</tt>, <tt>Array</tt>
|
|
2109
2360
|
|
|
2110
2361
|
|
|
2111
2362
|
|
|
@@ -2113,8 +2364,8 @@ copy reference to.</p>
|
|
|
2113
2364
|
|
|
2114
2365
|
</h3><div class="docstring">
|
|
2115
2366
|
<div class="discussion">
|
|
2116
|
-
<p>
|
|
2117
|
-
|
|
2367
|
+
<p>Returns the status of an asynchronous job for <span class='object_link'><a href="#copy_batch-instance_method" title="DropboxApi::Client#copy_batch (method)">#copy_batch</a></span>. It
|
|
2368
|
+
returns a list of results for each entry.</p>
|
|
2118
2369
|
|
|
2119
2370
|
|
|
2120
2371
|
</div>
|
|
@@ -2125,7 +2376,7 @@ user's Dropbox.</p>
|
|
|
2125
2376
|
|
|
2126
2377
|
<li>
|
|
2127
2378
|
|
|
2128
|
-
<span class='name'>
|
|
2379
|
+
<span class='name'>async_job_id</span>
|
|
2129
2380
|
|
|
2130
2381
|
|
|
2131
2382
|
<span class='type'>(<tt>String</tt>)</span>
|
|
@@ -2133,8 +2384,226 @@ user's Dropbox.</p>
|
|
|
2133
2384
|
|
|
2134
2385
|
|
|
2135
2386
|
—
|
|
2136
|
-
<div class='inline'><p>
|
|
2137
|
-
|
|
2387
|
+
<div class='inline'><p>Id of the asynchronous job.
|
|
2388
|
+
This is the value of a response returned from the method that
|
|
2389
|
+
launched the job.</p>
|
|
2390
|
+
</div>
|
|
2391
|
+
|
|
2392
|
+
</li>
|
|
2393
|
+
|
|
2394
|
+
</ul>
|
|
2395
|
+
|
|
2396
|
+
<p class="tag_title">Returns:</p>
|
|
2397
|
+
<ul class="return">
|
|
2398
|
+
|
|
2399
|
+
<li>
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
<span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
|
|
2403
|
+
|
|
2404
|
+
|
|
2405
|
+
|
|
2406
|
+
—
|
|
2407
|
+
<div class='inline'><p>This could be either the <code>:in_progress</code>
|
|
2408
|
+
flag or a list of job statuses.</p>
|
|
2409
|
+
</div>
|
|
2410
|
+
|
|
2411
|
+
</li>
|
|
2412
|
+
|
|
2413
|
+
</ul>
|
|
2414
|
+
|
|
2415
|
+
</div>
|
|
2416
|
+
<div class="tags">
|
|
2417
|
+
<p class="tag_title">Specifications:</p>
|
|
2418
|
+
<ul class="specs">
|
|
2419
|
+
|
|
2420
|
+
<li>
|
|
2421
|
+
returns all types of entries
|
|
2422
|
+
<table class="source_code test_code">
|
|
2423
|
+
<tr>
|
|
2424
|
+
<td>
|
|
2425
|
+
<pre class="lines">
|
|
2426
|
+
|
|
2427
|
+
|
|
2428
|
+
6
|
|
2429
|
+
7
|
|
2430
|
+
8
|
|
2431
|
+
9
|
|
2432
|
+
10</pre>
|
|
2433
|
+
</td>
|
|
2434
|
+
<td>
|
|
2435
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 16</span>
|
|
2436
|
+
|
|
2437
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch_check'>copy_batch_check</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsU</span><span class='tstring_end'>"</span></span>
|
|
2438
|
+
|
|
2439
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
2440
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
2441
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
|
|
2442
|
+
</td>
|
|
2443
|
+
</tr>
|
|
2444
|
+
</table>
|
|
2445
|
+
</li>
|
|
2446
|
+
|
|
2447
|
+
<li>
|
|
2448
|
+
returns 'invalid_async_job_id' error
|
|
2449
|
+
<table class="source_code test_code">
|
|
2450
|
+
<tr>
|
|
2451
|
+
<td>
|
|
2452
|
+
<pre class="lines">
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
14
|
|
2456
|
+
15
|
|
2457
|
+
16</pre>
|
|
2458
|
+
</td>
|
|
2459
|
+
<td>
|
|
2460
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/copy_batch_check_spec.rb', line 16</span>
|
|
2461
|
+
|
|
2462
|
+
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
|
|
2463
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_copy_batch_check'>copy_batch_check</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AADOVgzSRvtiBJ9dZaE8VUp07JT-zO7k9TrjEfwnzTfGGDuEi1pTRB2vFufnQfX9Yf-N_tzVl52rGEK4GYI8zzsE</span><span class='tstring_end'>"</span></span>
|
|
2464
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><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/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='rparen'>)</span></pre>
|
|
2465
|
+
</td>
|
|
2466
|
+
</tr>
|
|
2467
|
+
</table>
|
|
2468
|
+
</li>
|
|
2469
|
+
|
|
2470
|
+
</ul>
|
|
2471
|
+
</div>
|
|
2472
|
+
|
|
2473
|
+
<table class="source_code">
|
|
2474
|
+
<tr>
|
|
2475
|
+
<td>
|
|
2476
|
+
<pre class="lines">
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
16
|
|
2480
|
+
17
|
|
2481
|
+
18</pre>
|
|
2482
|
+
</td>
|
|
2483
|
+
<td>
|
|
2484
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_batch_check.rb', line 16</span>
|
|
2485
|
+
|
|
2486
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy_batch_check</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_async_job_id'>async_job_id</span><span class='op'>|</span>
|
|
2487
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='symbol'>:async_job_id</span> <span class='op'>=></span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
|
|
2488
|
+
<span class='kw'>end</span></pre>
|
|
2489
|
+
</td>
|
|
2490
|
+
</tr>
|
|
2491
|
+
</table>
|
|
2492
|
+
</div>
|
|
2493
|
+
|
|
2494
|
+
<div class="method_details ">
|
|
2495
|
+
<h3 class="signature " id="copy_reference_get-instance_method">
|
|
2496
|
+
|
|
2497
|
+
#<strong>copy_reference_get</strong>(path) ⇒ <tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>
|
|
2498
|
+
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
|
|
2502
|
+
|
|
2503
|
+
</h3><div class="docstring">
|
|
2504
|
+
<div class="discussion">
|
|
2505
|
+
<p>Get a copy reference to a file or folder.
|
|
2506
|
+
This reference string can be used to save that file or folder
|
|
2507
|
+
to another user's Dropbox by passing it to <span class='object_link'><a href="#copy_reference_save-instance_method" title="DropboxApi::Client#copy_reference_save (method)">#copy_reference_save</a></span>.</p>
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
</div>
|
|
2511
|
+
</div>
|
|
2512
|
+
<div class="tags">
|
|
2513
|
+
<p class="tag_title">Parameters:</p>
|
|
2514
|
+
<ul class="param">
|
|
2515
|
+
|
|
2516
|
+
<li>
|
|
2517
|
+
|
|
2518
|
+
<span class='name'>path</span>
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2522
|
+
|
|
2523
|
+
|
|
2524
|
+
|
|
2525
|
+
—
|
|
2526
|
+
<div class='inline'><p>The path to the file or folder you want to get a
|
|
2527
|
+
copy reference to.</p>
|
|
2528
|
+
</div>
|
|
2529
|
+
|
|
2530
|
+
</li>
|
|
2531
|
+
|
|
2532
|
+
</ul>
|
|
2533
|
+
|
|
2534
|
+
<p class="tag_title">Returns:</p>
|
|
2535
|
+
<ul class="return">
|
|
2536
|
+
|
|
2537
|
+
<li>
|
|
2538
|
+
|
|
2539
|
+
|
|
2540
|
+
<span class='type'>(<tt><span class='object_link'><a href="Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">DropboxApi::Results::GetCopyReferenceResult</a></span></tt>)</span>
|
|
2541
|
+
|
|
2542
|
+
|
|
2543
|
+
|
|
2544
|
+
</li>
|
|
2545
|
+
|
|
2546
|
+
</ul>
|
|
2547
|
+
|
|
2548
|
+
</div>
|
|
2549
|
+
<table class="source_code">
|
|
2550
|
+
<tr>
|
|
2551
|
+
<td>
|
|
2552
|
+
<pre class="lines">
|
|
2553
|
+
|
|
2554
|
+
|
|
2555
|
+
15
|
|
2556
|
+
16
|
|
2557
|
+
17
|
|
2558
|
+
18
|
|
2559
|
+
19</pre>
|
|
2560
|
+
</td>
|
|
2561
|
+
<td>
|
|
2562
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 15</span>
|
|
2563
|
+
|
|
2564
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy_reference_get</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
|
|
2565
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
2566
|
+
<span class='symbol'>:path</span> <span class='op'>=></span> <span class='id identifier rubyid_path'>path</span>
|
|
2567
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2568
|
+
<span class='kw'>end</span></pre>
|
|
2569
|
+
</td>
|
|
2570
|
+
</tr>
|
|
2571
|
+
</table>
|
|
2572
|
+
</div>
|
|
2573
|
+
|
|
2574
|
+
<div class="method_details ">
|
|
2575
|
+
<h3 class="signature " id="copy_reference_save-instance_method">
|
|
2576
|
+
|
|
2577
|
+
#<strong>copy_reference_save</strong>(copy_reference, path) ⇒ <tt><span class='object_link'><a href="Results/SaveCopyReferenceResult.html" title="DropboxApi::Results::SaveCopyReferenceResult (class)">DropboxApi::Results::SaveCopyReferenceResult</a></span></tt>
|
|
2578
|
+
|
|
2579
|
+
|
|
2580
|
+
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
</h3><div class="docstring">
|
|
2584
|
+
<div class="discussion">
|
|
2585
|
+
<p>Save a copy reference returned by <span class='object_link'><a href="#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">#copy_reference_get</a></span> to the
|
|
2586
|
+
user's Dropbox.</p>
|
|
2587
|
+
|
|
2588
|
+
|
|
2589
|
+
</div>
|
|
2590
|
+
</div>
|
|
2591
|
+
<div class="tags">
|
|
2592
|
+
<p class="tag_title">Parameters:</p>
|
|
2593
|
+
<ul class="param">
|
|
2594
|
+
|
|
2595
|
+
<li>
|
|
2596
|
+
|
|
2597
|
+
<span class='name'>copy_reference</span>
|
|
2598
|
+
|
|
2599
|
+
|
|
2600
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
|
|
2604
|
+
—
|
|
2605
|
+
<div class='inline'><p>A copy reference returned by
|
|
2606
|
+
<span class='object_link'><a href="#copy_reference_get-instance_method" title="DropboxApi::Client#copy_reference_get (method)">#copy_reference_get</a></span>.</p>
|
|
2138
2607
|
</div>
|
|
2139
2608
|
|
|
2140
2609
|
</li>
|
|
@@ -2327,8 +2796,8 @@ this will be relative to the app folder.</p>
|
|
|
2327
2796
|
|
|
2328
2797
|
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_file_request</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_title'>title</span><span class='comma'>,</span> <span class='id identifier rubyid_destination'>destination</span><span class='op'>|</span>
|
|
2329
2798
|
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
2330
|
-
<span class='
|
|
2331
|
-
<span class='
|
|
2799
|
+
<span class='symbol'>:title</span> <span class='op'>=></span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span>
|
|
2800
|
+
<span class='symbol'>:destination</span> <span class='op'>=></span> <span class='id identifier rubyid_destination'>destination</span>
|
|
2332
2801
|
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2333
2802
|
<span class='kw'>end</span></pre>
|
|
2334
2803
|
</td>
|
|
@@ -2496,9 +2965,9 @@ this will be relative to the app folder.</p>
|
|
|
2496
2965
|
</div>
|
|
2497
2966
|
|
|
2498
2967
|
<div class="method_details ">
|
|
2499
|
-
<h3 class="signature " id="
|
|
2968
|
+
<h3 class="signature " id="create_folder_batch-instance_method">
|
|
2500
2969
|
|
|
2501
|
-
#<strong>
|
|
2970
|
+
#<strong>create_folder_batch</strong>(paths, options = {}) ⇒ <tt>String</tt>, <tt>Array</tt>
|
|
2502
2971
|
|
|
2503
2972
|
|
|
2504
2973
|
|
|
@@ -2506,13 +2975,15 @@ this will be relative to the app folder.</p>
|
|
|
2506
2975
|
|
|
2507
2976
|
</h3><div class="docstring">
|
|
2508
2977
|
<div class="discussion">
|
|
2509
|
-
<p>Create
|
|
2510
|
-
the default visibility is :public. (The resolved
|
|
2511
|
-
visibility, though, may depend on other aspects such as team and shared
|
|
2512
|
-
folder settings).</p>
|
|
2978
|
+
<p>Create multiple folders at once.</p>
|
|
2513
2979
|
|
|
2514
|
-
<p>
|
|
2515
|
-
|
|
2980
|
+
<p>This route is asynchronous for large batches, which returns a job ID
|
|
2981
|
+
immediately and runs the create folder batch asynchronously. Otherwise,
|
|
2982
|
+
creates the folders and returns the result synchronously for smaller
|
|
2983
|
+
inputs. You can force asynchronous behaviour by using the <code>:force_async</code>
|
|
2984
|
+
flag. Use <span class='object_link'><a href="#create_folder_batch_check-instance_method" title="DropboxApi::Client#create_folder_batch_check (method)">#create_folder_batch_check</a></span> to check the job status.</p>
|
|
2985
|
+
|
|
2986
|
+
<p>Note: No errors are returned by this endpoint.</p>
|
|
2516
2987
|
|
|
2517
2988
|
|
|
2518
2989
|
</div>
|
|
@@ -2523,33 +2994,16 @@ enterprise accounts. It will return no permission error otherwise.</p>
|
|
|
2523
2994
|
|
|
2524
2995
|
<li>
|
|
2525
2996
|
|
|
2526
|
-
<span class='name'>
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
<span class='type'>(<tt>String</tt>)</span>
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
|
|
2533
|
-
—
|
|
2534
|
-
<div class='inline'><p>The path to be shared by the shared link.</p>
|
|
2535
|
-
</div>
|
|
2536
|
-
|
|
2537
|
-
</li>
|
|
2538
|
-
|
|
2539
|
-
<li>
|
|
2540
|
-
|
|
2541
|
-
<span class='name'>settings</span>
|
|
2542
|
-
|
|
2997
|
+
<span class='name'>paths</span>
|
|
2543
2998
|
|
|
2544
|
-
<span class='type'>(<tt>SharedLinkSettings</tt>)</span>
|
|
2545
2999
|
|
|
3000
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
2546
3001
|
|
|
2547
|
-
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
2548
3002
|
|
|
2549
3003
|
|
|
2550
3004
|
—
|
|
2551
|
-
<div class='inline'><p>
|
|
2552
|
-
|
|
3005
|
+
<div class='inline'><p>List of paths to be created in the user's Dropbox.
|
|
3006
|
+
Duplicate path arguments in the batch are considered only once.</p>
|
|
2553
3007
|
</div>
|
|
2554
3008
|
|
|
2555
3009
|
</li>
|
|
@@ -2561,45 +3015,475 @@ created shared link This field is optional.</p>
|
|
|
2561
3015
|
|
|
2562
3016
|
|
|
2563
3017
|
|
|
2564
|
-
<p class="tag_title">Options Hash (<tt>
|
|
3018
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
2565
3019
|
<ul class="option">
|
|
2566
3020
|
|
|
2567
3021
|
<li>
|
|
2568
|
-
<span class="name">
|
|
2569
|
-
<span class="type">(<tt>
|
|
3022
|
+
<span class="name">autorename</span>
|
|
3023
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
2570
3024
|
<span class="default">
|
|
2571
3025
|
|
|
2572
3026
|
</span>
|
|
2573
3027
|
|
|
2574
|
-
— <div class='inline'><p>
|
|
2575
|
-
|
|
2576
|
-
|
|
3028
|
+
— <div class='inline'><p>If there's a conflict, have the
|
|
3029
|
+
Dropbox server try to autorename the folder to avoid the conflict.
|
|
3030
|
+
The default for this field is <code>false</code>.</p>
|
|
2577
3031
|
</div>
|
|
2578
3032
|
|
|
2579
3033
|
</li>
|
|
2580
3034
|
|
|
2581
3035
|
<li>
|
|
2582
|
-
<span class="name">
|
|
2583
|
-
<span class="type">(<tt>
|
|
3036
|
+
<span class="name">force_async</span>
|
|
3037
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
2584
3038
|
<span class="default">
|
|
2585
3039
|
|
|
2586
3040
|
</span>
|
|
2587
3041
|
|
|
2588
|
-
— <div class='inline'><p>
|
|
2589
|
-
|
|
2590
|
-
This field is optional.</p>
|
|
3042
|
+
— <div class='inline'><p>Whether to force the create to
|
|
3043
|
+
happen asynchronously. The default for this field is <code>false</code>.</p>
|
|
2591
3044
|
</div>
|
|
2592
3045
|
|
|
2593
3046
|
</li>
|
|
2594
3047
|
|
|
2595
|
-
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
3048
|
+
</ul>
|
|
3049
|
+
|
|
3050
|
+
|
|
3051
|
+
<p class="tag_title">Returns:</p>
|
|
3052
|
+
<ul class="return">
|
|
3053
|
+
|
|
3054
|
+
<li>
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
<span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
|
|
3058
|
+
|
|
3059
|
+
|
|
3060
|
+
|
|
3061
|
+
—
|
|
3062
|
+
<div class='inline'><p>Either the job id or the list of job statuses.</p>
|
|
3063
|
+
</div>
|
|
3064
|
+
|
|
3065
|
+
</li>
|
|
3066
|
+
|
|
3067
|
+
</ul>
|
|
3068
|
+
|
|
3069
|
+
</div>
|
|
3070
|
+
<div class="tags">
|
|
3071
|
+
<p class="tag_title">Specifications:</p>
|
|
3072
|
+
<ul class="specs">
|
|
3073
|
+
|
|
3074
|
+
<li>
|
|
3075
|
+
returns the created folders synchronously
|
|
3076
|
+
<table class="source_code test_code">
|
|
3077
|
+
<tr>
|
|
3078
|
+
<td>
|
|
3079
|
+
<pre class="lines">
|
|
3080
|
+
|
|
3081
|
+
|
|
3082
|
+
6
|
|
3083
|
+
7
|
|
3084
|
+
8
|
|
3085
|
+
9</pre>
|
|
3086
|
+
</td>
|
|
3087
|
+
<td>
|
|
3088
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
|
|
3089
|
+
|
|
3090
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch 1</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
3091
|
+
|
|
3092
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span>
|
|
3093
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span></pre>
|
|
3094
|
+
</td>
|
|
3095
|
+
</tr>
|
|
3096
|
+
</table>
|
|
3097
|
+
</li>
|
|
3098
|
+
|
|
3099
|
+
<li>
|
|
3100
|
+
returns async_job_id when large entries are passed
|
|
3101
|
+
<table class="source_code test_code">
|
|
3102
|
+
<tr>
|
|
3103
|
+
<td>
|
|
3104
|
+
<pre class="lines">
|
|
3105
|
+
|
|
3106
|
+
|
|
3107
|
+
13
|
|
3108
|
+
14
|
|
3109
|
+
15
|
|
3110
|
+
16
|
|
3111
|
+
17
|
|
3112
|
+
18</pre>
|
|
3113
|
+
</td>
|
|
3114
|
+
<td>
|
|
3115
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
|
|
3116
|
+
|
|
3117
|
+
<span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
3118
|
+
<span class='int'>100</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_paths'>paths</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Folder </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_i'>i</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span>
|
|
3119
|
+
|
|
3120
|
+
<span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
|
|
3121
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
3122
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></pre>
|
|
3123
|
+
</td>
|
|
3124
|
+
</tr>
|
|
3125
|
+
</table>
|
|
3126
|
+
</li>
|
|
3127
|
+
|
|
3128
|
+
<li>
|
|
3129
|
+
returns async_job_id when force_async is true
|
|
3130
|
+
<table class="source_code test_code">
|
|
3131
|
+
<tr>
|
|
3132
|
+
<td>
|
|
3133
|
+
<pre class="lines">
|
|
3134
|
+
|
|
3135
|
+
|
|
3136
|
+
22
|
|
3137
|
+
23
|
|
3138
|
+
24
|
|
3139
|
+
25</pre>
|
|
3140
|
+
</td>
|
|
3141
|
+
<td>
|
|
3142
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
|
|
3143
|
+
|
|
3144
|
+
<span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch 2</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch 3</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:force_async</span> <span class='op'>=></span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
3145
|
+
|
|
3146
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
3147
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></pre>
|
|
3148
|
+
</td>
|
|
3149
|
+
</tr>
|
|
3150
|
+
</table>
|
|
3151
|
+
</li>
|
|
3152
|
+
|
|
3153
|
+
<li>
|
|
3154
|
+
when autorename is true, does not return error for repeated entries
|
|
3155
|
+
<table class="source_code test_code">
|
|
3156
|
+
<tr>
|
|
3157
|
+
<td>
|
|
3158
|
+
<pre class="lines">
|
|
3159
|
+
|
|
3160
|
+
|
|
3161
|
+
29
|
|
3162
|
+
30
|
|
3163
|
+
31</pre>
|
|
3164
|
+
</td>
|
|
3165
|
+
<td>
|
|
3166
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
|
|
3167
|
+
|
|
3168
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch 1</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch 1</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:autorename</span> <span class='op'>=></span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
3169
|
+
|
|
3170
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_not_to'>not_to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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/FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
|
|
3171
|
+
</td>
|
|
3172
|
+
</tr>
|
|
3173
|
+
</table>
|
|
3174
|
+
</li>
|
|
3175
|
+
|
|
3176
|
+
<li>
|
|
3177
|
+
raises error, when invalid option is passed
|
|
3178
|
+
<table class="source_code test_code">
|
|
3179
|
+
<tr>
|
|
3180
|
+
<td>
|
|
3181
|
+
<pre class="lines">
|
|
3182
|
+
|
|
3183
|
+
|
|
3184
|
+
35
|
|
3185
|
+
36
|
|
3186
|
+
37</pre>
|
|
3187
|
+
</td>
|
|
3188
|
+
<td>
|
|
3189
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_spec.rb', line 27</span>
|
|
3190
|
+
|
|
3191
|
+
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
|
|
3192
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch'>create_folder_batch</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch 4</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/Create Batch 5</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:async</span> <span class='op'>=></span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
3193
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='const'>ArgumentError</span><span class='rparen'>)</span></pre>
|
|
3194
|
+
</td>
|
|
3195
|
+
</tr>
|
|
3196
|
+
</table>
|
|
3197
|
+
</li>
|
|
3198
|
+
|
|
3199
|
+
</ul>
|
|
3200
|
+
</div>
|
|
3201
|
+
|
|
3202
|
+
<table class="source_code">
|
|
3203
|
+
<tr>
|
|
3204
|
+
<td>
|
|
3205
|
+
<pre class="lines">
|
|
3206
|
+
|
|
3207
|
+
|
|
3208
|
+
27
|
|
3209
|
+
28
|
|
3210
|
+
29
|
|
3211
|
+
30
|
|
3212
|
+
31
|
|
3213
|
+
32
|
|
3214
|
+
33
|
|
3215
|
+
34
|
|
3216
|
+
35
|
|
3217
|
+
36
|
|
3218
|
+
37
|
|
3219
|
+
38</pre>
|
|
3220
|
+
</td>
|
|
3221
|
+
<td>
|
|
3222
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch.rb', line 27</span>
|
|
3223
|
+
|
|
3224
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_folder_batch</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_paths'>paths</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>
|
|
3225
|
+
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
|
|
3226
|
+
<span class='symbol'>:autorename</span><span class='comma'>,</span>
|
|
3227
|
+
<span class='symbol'>:force_async</span>
|
|
3228
|
+
<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
3229
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:autorename</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
|
|
3230
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:force_async</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
|
|
3231
|
+
|
|
3232
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</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>
|
|
3233
|
+
<span class='symbol'>:paths</span> <span class='op'>=></span> <span class='id identifier rubyid_paths'>paths</span>
|
|
3234
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
3235
|
+
<span class='kw'>end</span></pre>
|
|
3236
|
+
</td>
|
|
3237
|
+
</tr>
|
|
3238
|
+
</table>
|
|
3239
|
+
</div>
|
|
3240
|
+
|
|
3241
|
+
<div class="method_details ">
|
|
3242
|
+
<h3 class="signature " id="create_folder_batch_check-instance_method">
|
|
3243
|
+
|
|
3244
|
+
#<strong>create_folder_batch_check</strong>(async_job_id) ⇒ <tt>Array</tt>
|
|
3245
|
+
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
|
|
3249
|
+
|
|
3250
|
+
</h3><div class="docstring">
|
|
3251
|
+
<div class="discussion">
|
|
3252
|
+
<p>Returns the status of an asynchronous job for create_folder_batch.
|
|
3253
|
+
If success, it returns list of result for each entry.</p>
|
|
3254
|
+
|
|
3255
|
+
|
|
3256
|
+
</div>
|
|
3257
|
+
</div>
|
|
3258
|
+
<div class="tags">
|
|
3259
|
+
<p class="tag_title">Parameters:</p>
|
|
3260
|
+
<ul class="param">
|
|
3261
|
+
|
|
3262
|
+
<li>
|
|
3263
|
+
|
|
3264
|
+
<span class='name'>async_job_id</span>
|
|
3265
|
+
|
|
3266
|
+
|
|
3267
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
3268
|
+
|
|
3269
|
+
|
|
3270
|
+
|
|
3271
|
+
—
|
|
3272
|
+
<div class='inline'><p>Id of the asynchronous job.
|
|
3273
|
+
This is the value of a response returned from the method that launched
|
|
3274
|
+
the job.</p>
|
|
3275
|
+
</div>
|
|
3276
|
+
|
|
3277
|
+
</li>
|
|
3278
|
+
|
|
3279
|
+
</ul>
|
|
3280
|
+
|
|
3281
|
+
<p class="tag_title">Returns:</p>
|
|
3282
|
+
<ul class="return">
|
|
3283
|
+
|
|
3284
|
+
<li>
|
|
3285
|
+
|
|
3286
|
+
|
|
3287
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
3288
|
+
|
|
3289
|
+
|
|
3290
|
+
|
|
3291
|
+
—
|
|
3292
|
+
<div class='inline'><p>A list of one result for each entry.</p>
|
|
3293
|
+
</div>
|
|
3294
|
+
|
|
3295
|
+
</li>
|
|
3296
|
+
|
|
3297
|
+
</ul>
|
|
3298
|
+
|
|
3299
|
+
</div>
|
|
3300
|
+
<div class="tags">
|
|
3301
|
+
<p class="tag_title">Specifications:</p>
|
|
3302
|
+
<ul class="specs">
|
|
3303
|
+
|
|
3304
|
+
<li>
|
|
3305
|
+
returns mixed results with failure and success status for each entry
|
|
3306
|
+
<table class="source_code test_code">
|
|
3307
|
+
<tr>
|
|
3308
|
+
<td>
|
|
3309
|
+
<pre class="lines">
|
|
3310
|
+
|
|
3311
|
+
|
|
3312
|
+
6
|
|
3313
|
+
7
|
|
3314
|
+
8
|
|
3315
|
+
9
|
|
3316
|
+
10</pre>
|
|
3317
|
+
</td>
|
|
3318
|
+
<td>
|
|
3319
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 15</span>
|
|
3320
|
+
|
|
3321
|
+
<span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch_check'>create_folder_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQE</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
3322
|
+
|
|
3323
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
3324
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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/MalformedPathError.html" title="DropboxApi::Errors::MalformedPathError (class)">MalformedPathError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
3325
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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/FolderConflictError.html" title="DropboxApi::Errors::FolderConflictError (class)">FolderConflictError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
|
|
3326
|
+
</td>
|
|
3327
|
+
</tr>
|
|
3328
|
+
</table>
|
|
3329
|
+
</li>
|
|
3330
|
+
|
|
3331
|
+
<li>
|
|
3332
|
+
raises an error with an invalid async job id
|
|
3333
|
+
<table class="source_code test_code">
|
|
3334
|
+
<tr>
|
|
3335
|
+
<td>
|
|
3336
|
+
<pre class="lines">
|
|
3337
|
+
|
|
3338
|
+
|
|
3339
|
+
14
|
|
3340
|
+
15
|
|
3341
|
+
16</pre>
|
|
3342
|
+
</td>
|
|
3343
|
+
<td>
|
|
3344
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/create_folder_batch_check_spec.rb', line 15</span>
|
|
3345
|
+
|
|
3346
|
+
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
|
|
3347
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_create_folder_batch_check'>create_folder_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
3348
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><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/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='rparen'>)</span></pre>
|
|
3349
|
+
</td>
|
|
3350
|
+
</tr>
|
|
3351
|
+
</table>
|
|
3352
|
+
</li>
|
|
3353
|
+
|
|
3354
|
+
</ul>
|
|
3355
|
+
</div>
|
|
3356
|
+
|
|
3357
|
+
<table class="source_code">
|
|
3358
|
+
<tr>
|
|
3359
|
+
<td>
|
|
3360
|
+
<pre class="lines">
|
|
3361
|
+
|
|
3362
|
+
|
|
3363
|
+
15
|
|
3364
|
+
16
|
|
3365
|
+
17
|
|
3366
|
+
18
|
|
3367
|
+
19</pre>
|
|
3368
|
+
</td>
|
|
3369
|
+
<td>
|
|
3370
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/create_folder_batch_check.rb', line 15</span>
|
|
3371
|
+
|
|
3372
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:create_folder_batch_check</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_async_job_id'>async_job_id</span><span class='op'>|</span>
|
|
3373
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
3374
|
+
<span class='symbol'>:async_job_id</span> <span class='op'>=></span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
|
|
3375
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
3376
|
+
<span class='kw'>end</span></pre>
|
|
3377
|
+
</td>
|
|
3378
|
+
</tr>
|
|
3379
|
+
</table>
|
|
3380
|
+
</div>
|
|
3381
|
+
|
|
3382
|
+
<div class="method_details ">
|
|
3383
|
+
<h3 class="signature " id="create_shared_link_with_settings-instance_method">
|
|
3384
|
+
|
|
3385
|
+
#<strong>create_shared_link_with_settings</strong>(path, settings = {}) ⇒ <tt><span class='object_link'><a href="Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">DropboxApi::Metadata::SharedLinkMetadata</a></span></tt>
|
|
3386
|
+
|
|
3387
|
+
|
|
3388
|
+
|
|
3389
|
+
|
|
3390
|
+
|
|
3391
|
+
</h3><div class="docstring">
|
|
3392
|
+
<div class="discussion">
|
|
3393
|
+
<p>Create a shared link with custom settings. If no settings are given then
|
|
3394
|
+
the default visibility is :public. (The resolved
|
|
3395
|
+
visibility, though, may depend on other aspects such as team and shared
|
|
3396
|
+
folder settings).</p>
|
|
3397
|
+
|
|
3398
|
+
<p>NOTE: The <code>settings</code> parameter will only work for pro, business or
|
|
3399
|
+
enterprise accounts. It will return no permission error otherwise.</p>
|
|
3400
|
+
|
|
3401
|
+
|
|
3402
|
+
</div>
|
|
3403
|
+
</div>
|
|
3404
|
+
<div class="tags">
|
|
3405
|
+
<p class="tag_title">Parameters:</p>
|
|
3406
|
+
<ul class="param">
|
|
3407
|
+
|
|
3408
|
+
<li>
|
|
3409
|
+
|
|
3410
|
+
<span class='name'>path</span>
|
|
3411
|
+
|
|
3412
|
+
|
|
3413
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
3414
|
+
|
|
3415
|
+
|
|
3416
|
+
|
|
3417
|
+
—
|
|
3418
|
+
<div class='inline'><p>The path to be shared by the shared link.</p>
|
|
3419
|
+
</div>
|
|
3420
|
+
|
|
3421
|
+
</li>
|
|
3422
|
+
|
|
3423
|
+
<li>
|
|
3424
|
+
|
|
3425
|
+
<span class='name'>settings</span>
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
<span class='type'>(<tt>SharedLinkSettings</tt>)</span>
|
|
3429
|
+
|
|
3430
|
+
|
|
3431
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
3432
|
+
|
|
3433
|
+
|
|
3434
|
+
—
|
|
3435
|
+
<div class='inline'><p>The requested settings for the newly
|
|
3436
|
+
created shared link This field is optional.</p>
|
|
3437
|
+
</div>
|
|
3438
|
+
|
|
3439
|
+
</li>
|
|
3440
|
+
|
|
3441
|
+
</ul>
|
|
3442
|
+
|
|
3443
|
+
|
|
3444
|
+
|
|
3445
|
+
|
|
3446
|
+
|
|
3447
|
+
|
|
3448
|
+
<p class="tag_title">Options Hash (<tt>settings</tt>):</p>
|
|
3449
|
+
<ul class="option">
|
|
3450
|
+
|
|
3451
|
+
<li>
|
|
3452
|
+
<span class="name">requested_visibility</span>
|
|
3453
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
3454
|
+
<span class="default">
|
|
3455
|
+
|
|
3456
|
+
</span>
|
|
3457
|
+
|
|
3458
|
+
— <div class='inline'><p>The requested access for this
|
|
3459
|
+
shared link. This field is optional. Must be one of "public",
|
|
3460
|
+
"team_only" or "password".</p>
|
|
3461
|
+
</div>
|
|
3462
|
+
|
|
3463
|
+
</li>
|
|
3464
|
+
|
|
3465
|
+
<li>
|
|
3466
|
+
<span class="name">link_password</span>
|
|
3467
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
3468
|
+
<span class="default">
|
|
3469
|
+
|
|
3470
|
+
</span>
|
|
3471
|
+
|
|
3472
|
+
— <div class='inline'><p>If requested_visibility is
|
|
3473
|
+
"password" this is needed to specify the password to access the link.
|
|
3474
|
+
This field is optional.</p>
|
|
3475
|
+
</div>
|
|
3476
|
+
|
|
3477
|
+
</li>
|
|
3478
|
+
|
|
3479
|
+
<li>
|
|
3480
|
+
<span class="name">expires</span>
|
|
3481
|
+
<span class="type">(<tt>Object</tt>)</span>
|
|
3482
|
+
<span class="default">
|
|
3483
|
+
|
|
3484
|
+
</span>
|
|
3485
|
+
|
|
3486
|
+
— <div class='inline'><p>Expiration time of the shared link. By default
|
|
2603
3487
|
the link won't expire. This field is optional.</p>
|
|
2604
3488
|
</div>
|
|
2605
3489
|
|
|
@@ -2660,7 +3544,7 @@ the link won't expire. This field is optional.</p>
|
|
|
2660
3544
|
|
|
2661
3545
|
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
2662
3546
|
<span class='symbol'>:path</span> <span class='op'>=></span> <span class='id identifier rubyid_path'>path</span><span class='comma'>,</span>
|
|
2663
|
-
<span class='symbol'>:settings</span
|
|
3547
|
+
<span class='symbol'>:settings</span> <span class='op'>=></span> <span class='id identifier rubyid_settings'>settings</span>
|
|
2664
3548
|
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
2665
3549
|
<span class='kw'>end</span></pre>
|
|
2666
3550
|
</td>
|
|
@@ -2870,6 +3754,295 @@ deleting a folder. If the given "rev" doesn't match, a
|
|
|
2870
3754
|
</td>
|
|
2871
3755
|
</tr>
|
|
2872
3756
|
</table>
|
|
3757
|
+
</div>
|
|
3758
|
+
|
|
3759
|
+
<div class="method_details ">
|
|
3760
|
+
<h3 class="signature " id="delete_batch-instance_method">
|
|
3761
|
+
|
|
3762
|
+
#<strong>delete_batch</strong>(entries) ⇒ <tt>String</tt>, <tt>Array</tt>
|
|
3763
|
+
|
|
3764
|
+
|
|
3765
|
+
|
|
3766
|
+
|
|
3767
|
+
|
|
3768
|
+
</h3><div class="docstring">
|
|
3769
|
+
<div class="discussion">
|
|
3770
|
+
<p>Delete multiple files/folders at once.</p>
|
|
3771
|
+
|
|
3772
|
+
<p>This route is asynchronous, which returns a job ID immediately and runs
|
|
3773
|
+
the delete batch asynchronously. Use <span class='object_link'><a href="#delete_batch_check-instance_method" title="DropboxApi::Client#delete_batch_check (method)">#delete_batch_check</a></span> to check
|
|
3774
|
+
the job status.</p>
|
|
3775
|
+
|
|
3776
|
+
|
|
3777
|
+
</div>
|
|
3778
|
+
</div>
|
|
3779
|
+
<div class="tags">
|
|
3780
|
+
<p class="tag_title">Parameters:</p>
|
|
3781
|
+
<ul class="param">
|
|
3782
|
+
|
|
3783
|
+
<li>
|
|
3784
|
+
|
|
3785
|
+
<span class='name'>entries</span>
|
|
3786
|
+
|
|
3787
|
+
|
|
3788
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
3789
|
+
|
|
3790
|
+
|
|
3791
|
+
|
|
3792
|
+
—
|
|
3793
|
+
<div class='inline'><p>List of entries, each entry is a Hash with these
|
|
3794
|
+
fields: <code>path</code> (mandatory) & parent_rev (optional).</p>
|
|
3795
|
+
</div>
|
|
3796
|
+
|
|
3797
|
+
</li>
|
|
3798
|
+
|
|
3799
|
+
</ul>
|
|
3800
|
+
|
|
3801
|
+
<p class="tag_title">Returns:</p>
|
|
3802
|
+
<ul class="return">
|
|
3803
|
+
|
|
3804
|
+
<li>
|
|
3805
|
+
|
|
3806
|
+
|
|
3807
|
+
<span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
|
|
3808
|
+
|
|
3809
|
+
|
|
3810
|
+
|
|
3811
|
+
—
|
|
3812
|
+
<div class='inline'><p>Either the job id or the list of job statuses.</p>
|
|
3813
|
+
</div>
|
|
3814
|
+
|
|
3815
|
+
</li>
|
|
3816
|
+
|
|
3817
|
+
</ul>
|
|
3818
|
+
|
|
3819
|
+
</div>
|
|
3820
|
+
<div class="tags">
|
|
3821
|
+
<p class="tag_title">Specifications:</p>
|
|
3822
|
+
<ul class="specs">
|
|
3823
|
+
|
|
3824
|
+
<li>
|
|
3825
|
+
returns async_job_id for multiple entries
|
|
3826
|
+
<table class="source_code test_code">
|
|
3827
|
+
<tr>
|
|
3828
|
+
<td>
|
|
3829
|
+
<pre class="lines">
|
|
3830
|
+
|
|
3831
|
+
|
|
3832
|
+
8
|
|
3833
|
+
9
|
|
3834
|
+
10
|
|
3835
|
+
11
|
|
3836
|
+
12</pre>
|
|
3837
|
+
</td>
|
|
3838
|
+
<td>
|
|
3839
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 16</span>
|
|
3840
|
+
|
|
3841
|
+
<span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='lbrace'>{</span> <span class='symbol'>:path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/folder_to_delete_1</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='symbol'>:path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/folder_to_delete_2</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='rbracket'>]</span>
|
|
3842
|
+
<span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch'>delete_batch</span> <span class='id identifier rubyid_entries'>entries</span>
|
|
3843
|
+
|
|
3844
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
3845
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></pre>
|
|
3846
|
+
</td>
|
|
3847
|
+
</tr>
|
|
3848
|
+
</table>
|
|
3849
|
+
</li>
|
|
3850
|
+
|
|
3851
|
+
<li>
|
|
3852
|
+
returns async_job_id for single entry too
|
|
3853
|
+
<table class="source_code test_code">
|
|
3854
|
+
<tr>
|
|
3855
|
+
<td>
|
|
3856
|
+
<pre class="lines">
|
|
3857
|
+
|
|
3858
|
+
|
|
3859
|
+
16
|
|
3860
|
+
17
|
|
3861
|
+
18
|
|
3862
|
+
19
|
|
3863
|
+
20</pre>
|
|
3864
|
+
</td>
|
|
3865
|
+
<td>
|
|
3866
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_spec.rb', line 16</span>
|
|
3867
|
+
|
|
3868
|
+
<span class='id identifier rubyid_entries'>entries</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='lbrace'>{</span> <span class='symbol'>:path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/folder_to_delete/file_to_delete.docx</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:parent_rev</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1c0576c68d6</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='rbracket'>]</span>
|
|
3869
|
+
<span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch'>delete_batch</span> <span class='id identifier rubyid_entries'>entries</span>
|
|
3870
|
+
|
|
3871
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><span class='const'>Hash</span><span class='rparen'>)</span>
|
|
3872
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_have_key'>have_key</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>async_job_id</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></pre>
|
|
3873
|
+
</td>
|
|
3874
|
+
</tr>
|
|
3875
|
+
</table>
|
|
3876
|
+
</li>
|
|
3877
|
+
|
|
3878
|
+
</ul>
|
|
3879
|
+
</div>
|
|
3880
|
+
|
|
3881
|
+
<table class="source_code">
|
|
3882
|
+
<tr>
|
|
3883
|
+
<td>
|
|
3884
|
+
<pre class="lines">
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
16
|
|
3888
|
+
17
|
|
3889
|
+
18
|
|
3890
|
+
19
|
|
3891
|
+
20</pre>
|
|
3892
|
+
</td>
|
|
3893
|
+
<td>
|
|
3894
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch.rb', line 16</span>
|
|
3895
|
+
|
|
3896
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:delete_batch</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_entries'>entries</span><span class='op'>|</span>
|
|
3897
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
3898
|
+
<span class='symbol'>:entries</span> <span class='op'>=></span> <span class='id identifier rubyid_entries'>entries</span>
|
|
3899
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
3900
|
+
<span class='kw'>end</span></pre>
|
|
3901
|
+
</td>
|
|
3902
|
+
</tr>
|
|
3903
|
+
</table>
|
|
3904
|
+
</div>
|
|
3905
|
+
|
|
3906
|
+
<div class="method_details ">
|
|
3907
|
+
<h3 class="signature " id="delete_batch_check-instance_method">
|
|
3908
|
+
|
|
3909
|
+
#<strong>delete_batch_check</strong>(async_job_id) ⇒ <tt>:in_progress</tt>, <tt>Array</tt>
|
|
3910
|
+
|
|
3911
|
+
|
|
3912
|
+
|
|
3913
|
+
|
|
3914
|
+
|
|
3915
|
+
</h3><div class="docstring">
|
|
3916
|
+
<div class="discussion">
|
|
3917
|
+
<p>Returns the status of an asynchronous job for delete_batch. If success,
|
|
3918
|
+
it returns list of result for each entry.</p>
|
|
3919
|
+
|
|
3920
|
+
|
|
3921
|
+
</div>
|
|
3922
|
+
</div>
|
|
3923
|
+
<div class="tags">
|
|
3924
|
+
<p class="tag_title">Parameters:</p>
|
|
3925
|
+
<ul class="param">
|
|
3926
|
+
|
|
3927
|
+
<li>
|
|
3928
|
+
|
|
3929
|
+
<span class='name'>async_job_id</span>
|
|
3930
|
+
|
|
3931
|
+
|
|
3932
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
3933
|
+
|
|
3934
|
+
|
|
3935
|
+
|
|
3936
|
+
—
|
|
3937
|
+
<div class='inline'><p>Id of the asynchronous job.</p>
|
|
3938
|
+
</div>
|
|
3939
|
+
|
|
3940
|
+
</li>
|
|
3941
|
+
|
|
3942
|
+
</ul>
|
|
3943
|
+
|
|
3944
|
+
<p class="tag_title">Returns:</p>
|
|
3945
|
+
<ul class="return">
|
|
3946
|
+
|
|
3947
|
+
<li>
|
|
3948
|
+
|
|
3949
|
+
|
|
3950
|
+
<span class='type'>(<tt>:in_progress</tt>, <tt>Array</tt>)</span>
|
|
3951
|
+
|
|
3952
|
+
|
|
3953
|
+
|
|
3954
|
+
—
|
|
3955
|
+
<div class='inline'><p>This could be either the <code>:in_progress</code>
|
|
3956
|
+
flag or a list of job statuses.</p>
|
|
3957
|
+
</div>
|
|
3958
|
+
|
|
3959
|
+
</li>
|
|
3960
|
+
|
|
3961
|
+
</ul>
|
|
3962
|
+
|
|
3963
|
+
</div>
|
|
3964
|
+
<div class="tags">
|
|
3965
|
+
<p class="tag_title">Specifications:</p>
|
|
3966
|
+
<ul class="specs">
|
|
3967
|
+
|
|
3968
|
+
<li>
|
|
3969
|
+
returns mixed results when complete
|
|
3970
|
+
<table class="source_code test_code">
|
|
3971
|
+
<tr>
|
|
3972
|
+
<td>
|
|
3973
|
+
<pre class="lines">
|
|
3974
|
+
|
|
3975
|
+
|
|
3976
|
+
6
|
|
3977
|
+
7
|
|
3978
|
+
8
|
|
3979
|
+
9
|
|
3980
|
+
10
|
|
3981
|
+
11</pre>
|
|
3982
|
+
</td>
|
|
3983
|
+
<td>
|
|
3984
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 14</span>
|
|
3985
|
+
|
|
3986
|
+
<span class='id identifier rubyid_async_result'>async_result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch_check'>delete_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AAC2JUPMEtK-kEg7QVrNEemnX-FfQkJ_0r_tJJ2UpHhwvrUGrpw19CH4U5cfZKWPLxLVJoKgffTOy_zSKk6W953h</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
3987
|
+
|
|
3988
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Folder.html" title="DropboxApi::Metadata::Folder (class)">Folder</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
3989
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/File.html" title="DropboxApi::Metadata::File (class)">File</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
3990
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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/FileConflictError.html" title="DropboxApi::Errors::FileConflictError (class)">FileConflictError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
|
|
3991
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_async_result'>async_result</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_include'>include</span><span class='lparen'>(</span><span class='id identifier rubyid_a_kind_of'>a_kind_of</span><span class='lparen'>(</span><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/NotFoundError.html" title="DropboxApi::Errors::NotFoundError (class)">NotFoundError</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span></pre>
|
|
3992
|
+
</td>
|
|
3993
|
+
</tr>
|
|
3994
|
+
</table>
|
|
3995
|
+
</li>
|
|
3996
|
+
|
|
3997
|
+
<li>
|
|
3998
|
+
raises an error with an invalid async job id
|
|
3999
|
+
<table class="source_code test_code">
|
|
4000
|
+
<tr>
|
|
4001
|
+
<td>
|
|
4002
|
+
<pre class="lines">
|
|
4003
|
+
|
|
4004
|
+
|
|
4005
|
+
15
|
|
4006
|
+
16
|
|
4007
|
+
17</pre>
|
|
4008
|
+
</td>
|
|
4009
|
+
<td>
|
|
4010
|
+
<pre class="code"><span class="info file"># File 'spec/endpoints/files/delete_batch_check_spec.rb', line 14</span>
|
|
4011
|
+
|
|
4012
|
+
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
|
|
4013
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete_batch_check'>delete_batch_check</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dbjid:AAA8ixe2PLtuFEtS216inFdIa5J8PM5f8c9IcRimbLVqQ-0-bzq0yFEv1yu4UeCSUyZqQn80SjL5cbY-Ow9RBNQT</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
4014
|
+
<span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><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/InvalidIdError.html" title="DropboxApi::Errors::InvalidIdError (class)">InvalidIdError</a></span></span><span class='rparen'>)</span></pre>
|
|
4015
|
+
</td>
|
|
4016
|
+
</tr>
|
|
4017
|
+
</table>
|
|
4018
|
+
</li>
|
|
4019
|
+
|
|
4020
|
+
</ul>
|
|
4021
|
+
</div>
|
|
4022
|
+
|
|
4023
|
+
<table class="source_code">
|
|
4024
|
+
<tr>
|
|
4025
|
+
<td>
|
|
4026
|
+
<pre class="lines">
|
|
4027
|
+
|
|
4028
|
+
|
|
4029
|
+
14
|
|
4030
|
+
15
|
|
4031
|
+
16
|
|
4032
|
+
17
|
|
4033
|
+
18</pre>
|
|
4034
|
+
</td>
|
|
4035
|
+
<td>
|
|
4036
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/delete_batch_check.rb', line 14</span>
|
|
4037
|
+
|
|
4038
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:delete_batch_check</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_async_job_id'>async_job_id</span><span class='op'>|</span>
|
|
4039
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
4040
|
+
<span class='symbol'>:async_job_id</span> <span class='op'>=></span> <span class='id identifier rubyid_async_job_id'>async_job_id</span>
|
|
4041
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
4042
|
+
<span class='kw'>end</span></pre>
|
|
4043
|
+
</td>
|
|
4044
|
+
</tr>
|
|
4045
|
+
</table>
|
|
2873
4046
|
</div>
|
|
2874
4047
|
|
|
2875
4048
|
<div class="method_details ">
|
|
@@ -3267,9 +4440,9 @@ contain any duplicate account IDs.</p>
|
|
|
3267
4440
|
<td>
|
|
3268
4441
|
<pre class="code"><span class="info file"># File 'spec/endpoints/users/get_account_batch_spec.rb', line 14</span>
|
|
3269
4442
|
|
|
3270
|
-
<span class='id identifier rubyid_account_ids'>account_ids</span> <span class='op'>=</span> <span class='qwords_beg'>%w(
|
|
3271
|
-
</span><span class='tstring_content'>
|
|
3272
|
-
</span><span class='tstring_content'>
|
|
4443
|
+
<span class='id identifier rubyid_account_ids'>account_ids</span> <span class='op'>=</span> <span class='qwords_beg'>%w(</span><span class='words_sep'>
|
|
4444
|
+
</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtXXX</span><span class='words_sep'>
|
|
4445
|
+
</span><span class='tstring_content'>dbid:AAAKVPLEKkkccsZMFkkZNXFeyXrPPhrtFxs</span><span class='words_sep'>
|
|
3273
4446
|
</span><span class='tstring_end'>)</span></span>
|
|
3274
4447
|
|
|
3275
4448
|
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span>
|
|
@@ -3893,7 +5066,7 @@ a password, this parameter can be used.</p>
|
|
|
3893
5066
|
<pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 22</span>
|
|
3894
5067
|
|
|
3895
5068
|
<span class='id identifier rubyid_shared_link'>shared_link</span> <span class='op'>=</span> <span class='ivar'>@client</span>
|
|
3896
|
-
<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='
|
|
5069
|
+
<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='symbol'>:path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_file.txt</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
3897
5070
|
<span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
|
|
3898
5071
|
<span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
3899
5072
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> <span class='id identifier rubyid_shared_link'>shared_link</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
|
|
@@ -3924,7 +5097,7 @@ a password, this parameter can be used.</p>
|
|
|
3924
5097
|
<pre class="code"><span class="info file"># File 'spec/endpoints/sharing/get_shared_link_metadata_spec.rb', line 22</span>
|
|
3925
5098
|
|
|
3926
5099
|
<span class='id identifier rubyid_shared_link'>shared_link</span> <span class='op'>=</span> <span class='ivar'>@client</span>
|
|
3927
|
-
<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='
|
|
5100
|
+
<span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='symbol'>:path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
3928
5101
|
<span class='period'>.</span><span class='id identifier rubyid_links'>links</span>
|
|
3929
5102
|
<span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
3930
5103
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_shared_link_metadata'>get_shared_link_metadata</span> <span class='id identifier rubyid_shared_link'>shared_link</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
|
|
@@ -5036,7 +6209,7 @@ this is "approximate", and more may be returned)</p>
|
|
|
5036
6209
|
<pre class="code"><span class="info file"># File 'spec/endpoints/files/list_folder_spec.rb', line 28</span>
|
|
5037
6210
|
|
|
5038
6211
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_shared_links'>list_shared_links</span><span class='lparen'>(</span><span class='symbol'>:path</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path_prefix'>path_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>/shared_folder</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
5039
|
-
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='
|
|
6212
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list_folder'>list_folder</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:shared_link</span> <span class='op'>=></span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span>
|
|
5040
6213
|
|
|
5041
6214
|
<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_entries'>entries</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_resource'>resource</span><span class='op'>|</span>
|
|
5042
6215
|
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_resource'>resource</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be_a'>be_a</span><span class='lparen'>(</span><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="Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Metadata/Base.html" title="DropboxApi::Metadata::Base (class)">Base</a></span></span><span class='rparen'>)</span>
|
|
@@ -8923,9 +10096,9 @@ that you can use to continue the upload afterwards.</p>
|
|
|
8923
10096
|
</div>
|
|
8924
10097
|
|
|
8925
10098
|
<div id="footer">
|
|
8926
|
-
Generated on
|
|
10099
|
+
Generated on Fri May 31 17:53:31 2019 by
|
|
8927
10100
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
8928
|
-
0.9.
|
|
10101
|
+
0.9.19 (ruby-2.6.2).
|
|
8929
10102
|
</div>
|
|
8930
10103
|
|
|
8931
10104
|
</div>
|