dropbox_api 0.1.14 → 0.1.15
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/.gitignore +0 -1
- data/.yardopts +1 -0
- data/docs/DropboxApi.html +135 -0
- data/docs/DropboxApi/Authenticator.html +217 -0
- data/docs/DropboxApi/ChunkedUploader.html +409 -0
- data/docs/DropboxApi/Client.html +8747 -0
- data/docs/DropboxApi/ConnectionBuilder.html +326 -0
- data/docs/DropboxApi/Endpoints.html +119 -0
- data/docs/DropboxApi/Endpoints/Auth.html +115 -0
- data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +265 -0
- data/docs/DropboxApi/Endpoints/Base.html +197 -0
- data/docs/DropboxApi/Endpoints/ContentDownload.html +383 -0
- data/docs/DropboxApi/Endpoints/ContentUpload.html +351 -0
- data/docs/DropboxApi/Endpoints/Files.html +117 -0
- data/docs/DropboxApi/Endpoints/Files/Copy.html +323 -0
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +304 -0
- data/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +320 -0
- data/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +307 -0
- data/docs/DropboxApi/Endpoints/Files/CreateFolder.html +305 -0
- data/docs/DropboxApi/Endpoints/Files/Delete.html +341 -0
- data/docs/DropboxApi/Endpoints/Files/Download.html +284 -0
- data/docs/DropboxApi/Endpoints/Files/GetMetadata.html +376 -0
- data/docs/DropboxApi/Endpoints/Files/GetPreview.html +286 -0
- data/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +286 -0
- data/docs/DropboxApi/Endpoints/Files/GetThumbnail.html +388 -0
- data/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +431 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolder.html +383 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +298 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +371 -0
- data/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +360 -0
- data/docs/DropboxApi/Endpoints/Files/ListRevisions.html +338 -0
- data/docs/DropboxApi/Endpoints/Files/Move.html +364 -0
- data/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +337 -0
- data/docs/DropboxApi/Endpoints/Files/Restore.html +305 -0
- data/docs/DropboxApi/Endpoints/Files/SaveUrl.html +324 -0
- data/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +306 -0
- data/docs/DropboxApi/Endpoints/Files/Search.html +399 -0
- data/docs/DropboxApi/Endpoints/Files/Upload.html +439 -0
- data/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +377 -0
- data/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +328 -0
- data/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +350 -0
- data/docs/DropboxApi/Endpoints/Rpc.html +353 -0
- data/docs/DropboxApi/Endpoints/RpcContent.html +236 -0
- data/docs/DropboxApi/Endpoints/RpcNotify.html +240 -0
- data/docs/DropboxApi/Endpoints/Sharing.html +117 -0
- data/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +415 -0
- data/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +400 -0
- data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +322 -0
- data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html +344 -0
- data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html +421 -0
- data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html +400 -0
- data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html +345 -0
- data/docs/DropboxApi/Endpoints/Sharing/ShareFolder.html +428 -0
- data/docs/DropboxApi/Endpoints/Sharing/UnshareFile.html +290 -0
- data/docs/DropboxApi/Endpoints/Users.html +117 -0
- data/docs/DropboxApi/Endpoints/Users/GetAccount.html +301 -0
- data/docs/DropboxApi/Endpoints/Users/GetAccountBatch.html +303 -0
- data/docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html +282 -0
- data/docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html +282 -0
- data/docs/DropboxApi/Errors.html +117 -0
- data/docs/DropboxApi/Errors/AddFileMemberError.html +164 -0
- data/docs/DropboxApi/Errors/AddFolderMemberError.html +170 -0
- data/docs/DropboxApi/Errors/AddMemberSelectorError.html +165 -0
- data/docs/DropboxApi/Errors/AlreadySharedError.html +213 -0
- data/docs/DropboxApi/Errors/BadPathError.html +143 -0
- data/docs/DropboxApi/Errors/BasicError.html +356 -0
- data/docs/DropboxApi/Errors/CantCopySharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +143 -0
- data/docs/DropboxApi/Errors/CantNestSharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +143 -0
- data/docs/DropboxApi/Errors/ContainsSharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/ConversionError.html +143 -0
- data/docs/DropboxApi/Errors/CreateFileRequestError.html +160 -0
- data/docs/DropboxApi/Errors/CreateFolderError.html +161 -0
- data/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +165 -0
- data/docs/DropboxApi/Errors/CursorClosedError.html +143 -0
- data/docs/DropboxApi/Errors/CursorNotClosedError.html +143 -0
- data/docs/DropboxApi/Errors/DeleteError.html +162 -0
- data/docs/DropboxApi/Errors/DisallowedNameError.html +143 -0
- data/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +143 -0
- data/docs/DropboxApi/Errors/DownloadError.html +161 -0
- data/docs/DropboxApi/Errors/DownloadFailedError.html +143 -0
- data/docs/DropboxApi/Errors/EmailUnverifiedError.html +143 -0
- data/docs/DropboxApi/Errors/FileAncestorConflictError.html +143 -0
- data/docs/DropboxApi/Errors/FileConflictError.html +143 -0
- data/docs/DropboxApi/Errors/FileMemberActionError.html +164 -0
- data/docs/DropboxApi/Errors/FolderConflictError.html +143 -0
- data/docs/DropboxApi/Errors/GetAccountError.html +161 -0
- data/docs/DropboxApi/Errors/GetCopyReferenceError.html +161 -0
- data/docs/DropboxApi/Errors/GetMetadataError.html +161 -0
- data/docs/DropboxApi/Errors/GroupDeletedError.html +143 -0
- data/docs/DropboxApi/Errors/GroupNotOnTeamError.html +143 -0
- data/docs/DropboxApi/Errors/HttpError.html +124 -0
- data/docs/DropboxApi/Errors/InProgressError.html +143 -0
- data/docs/DropboxApi/Errors/InsideAppFolderError.html +143 -0
- data/docs/DropboxApi/Errors/InsideOsxPackageError.html +143 -0
- data/docs/DropboxApi/Errors/InsidePublicFolderError.html +143 -0
- data/docs/DropboxApi/Errors/InsideSharedFolderError.html +143 -0
- data/docs/DropboxApi/Errors/InsufficientPlanError.html +143 -0
- data/docs/DropboxApi/Errors/InsufficientSpaceError.html +143 -0
- data/docs/DropboxApi/Errors/InternalError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidCommentError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidCursorError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidDropboxIdError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidEmailError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidFileError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidIdError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidMemberError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidPathError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidRevisionError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidSettingsError.html +143 -0
- data/docs/DropboxApi/Errors/InvalidUrlError.html +143 -0
- data/docs/DropboxApi/Errors/IsAppFolderError.html +143 -0
- data/docs/DropboxApi/Errors/IsFileError.html +143 -0
- data/docs/DropboxApi/Errors/IsFolderError.html +143 -0
- data/docs/DropboxApi/Errors/IsOsxPackageError.html +143 -0
- data/docs/DropboxApi/Errors/IsPublicFolderError.html +143 -0
- data/docs/DropboxApi/Errors/ListFolderContinueError.html +162 -0
- data/docs/DropboxApi/Errors/ListFolderError.html +161 -0
- data/docs/DropboxApi/Errors/ListFolderLongpollError.html +161 -0
- data/docs/DropboxApi/Errors/ListRevisionsError.html +161 -0
- data/docs/DropboxApi/Errors/ListSharedLinksError.html +162 -0
- data/docs/DropboxApi/Errors/LookupError.html +165 -0
- data/docs/DropboxApi/Errors/MalformedPathError.html +143 -0
- data/docs/DropboxApi/Errors/NoAccountError.html +143 -0
- data/docs/DropboxApi/Errors/NoPermissionError.html +143 -0
- data/docs/DropboxApi/Errors/NoWritePermissionError.html +143 -0
- data/docs/DropboxApi/Errors/NotAMemberError.html +143 -0
- data/docs/DropboxApi/Errors/NotFileError.html +143 -0
- data/docs/DropboxApi/Errors/NotFolderError.html +143 -0
- data/docs/DropboxApi/Errors/NotFoundError.html +143 -0
- data/docs/DropboxApi/Errors/PollError.html +162 -0
- data/docs/DropboxApi/Errors/PreviewError.html +164 -0
- data/docs/DropboxApi/Errors/RateLimitError.html +143 -0
- data/docs/DropboxApi/Errors/RelocationError.html +167 -0
- data/docs/DropboxApi/Errors/RestoreError.html +163 -0
- data/docs/DropboxApi/Errors/RestrictedContentError.html +143 -0
- data/docs/DropboxApi/Errors/SaveCopyReferenceError.html +165 -0
- data/docs/DropboxApi/Errors/SaveUrlError.html +164 -0
- data/docs/DropboxApi/Errors/SearchError.html +161 -0
- data/docs/DropboxApi/Errors/SettingsError.html +162 -0
- data/docs/DropboxApi/Errors/ShareFolderError.html +165 -0
- data/docs/DropboxApi/Errors/SharePathError.html +171 -0
- data/docs/DropboxApi/Errors/SharedFolderAccessError.html +164 -0
- data/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +143 -0
- data/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +143 -0
- data/docs/DropboxApi/Errors/SharedLinkError.html +163 -0
- data/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +143 -0
- data/docs/DropboxApi/Errors/SharingFileAccessError.html +165 -0
- data/docs/DropboxApi/Errors/SharingUserError.html +161 -0
- data/docs/DropboxApi/Errors/TeamFolderError.html +143 -0
- data/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +143 -0
- data/docs/DropboxApi/Errors/ThumbnailBatchError.html +161 -0
- data/docs/DropboxApi/Errors/ThumbnailError.html +164 -0
- data/docs/DropboxApi/Errors/TooManyFilesError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyMembersError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyRequestsError.html +321 -0
- data/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +143 -0
- data/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +167 -0
- data/docs/DropboxApi/Errors/UnmountedError.html +143 -0
- data/docs/DropboxApi/Errors/UnshareFileError.html +162 -0
- data/docs/DropboxApi/Errors/UnsupportedContentError.html +143 -0
- data/docs/DropboxApi/Errors/UnsupportedExtensionError.html +143 -0
- data/docs/DropboxApi/Errors/UnsupportedImageError.html +143 -0
- data/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +143 -0
- data/docs/DropboxApi/Errors/UnverifiedDropboxId.html +143 -0
- data/docs/DropboxApi/Errors/UploadError.html +161 -0
- data/docs/DropboxApi/Errors/UploadSessionFinishError.html +163 -0
- data/docs/DropboxApi/Errors/UploadSessionLookupError.html +164 -0
- data/docs/DropboxApi/Errors/UploadSessionOffsetError.html +220 -0
- data/docs/DropboxApi/Errors/UploadWriteFailedError.html +161 -0
- data/docs/DropboxApi/Errors/WriteConflictError.html +163 -0
- data/docs/DropboxApi/Errors/WriteError.html +165 -0
- data/docs/DropboxApi/Metadata.html +117 -0
- data/docs/DropboxApi/Metadata/AccessLevel.html +259 -0
- data/docs/DropboxApi/Metadata/AddFileMemberResult.html +164 -0
- data/docs/DropboxApi/Metadata/AddMember.html +246 -0
- data/docs/DropboxApi/Metadata/Base.html +545 -0
- data/docs/DropboxApi/Metadata/BasicAccount.html +167 -0
- data/docs/DropboxApi/Metadata/CommitInfo.html +232 -0
- data/docs/DropboxApi/Metadata/Deleted.html +158 -0
- data/docs/DropboxApi/Metadata/Dimensions.html +140 -0
- data/docs/DropboxApi/Metadata/Field.html +358 -0
- data/docs/DropboxApi/Metadata/File.html +238 -0
- data/docs/DropboxApi/Metadata/FileLinkMetadata.html +180 -0
- data/docs/DropboxApi/Metadata/FileMemberAction.html +230 -0
- data/docs/DropboxApi/Metadata/FileRequest.html +167 -0
- data/docs/DropboxApi/Metadata/Folder.html +228 -0
- data/docs/DropboxApi/Metadata/FolderLinkMetadata.html +140 -0
- data/docs/DropboxApi/Metadata/FolderSharingInfo.html +156 -0
- data/docs/DropboxApi/Metadata/LinkPermissions.html +161 -0
- data/docs/DropboxApi/Metadata/Location.html +140 -0
- data/docs/DropboxApi/Metadata/MediaInfo.html +245 -0
- data/docs/DropboxApi/Metadata/MediaMetadata.html +237 -0
- data/docs/DropboxApi/Metadata/Member.html +313 -0
- data/docs/DropboxApi/Metadata/MemberAction.html +274 -0
- data/docs/DropboxApi/Metadata/MemberActionList.html +221 -0
- data/docs/DropboxApi/Metadata/MemberPermission.html +163 -0
- data/docs/DropboxApi/Metadata/MemberPermissionList.html +237 -0
- data/docs/DropboxApi/Metadata/Name.html +158 -0
- data/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +140 -0
- data/docs/DropboxApi/Metadata/PhotoMetadata.html +164 -0
- data/docs/DropboxApi/Metadata/Resource.html +207 -0
- data/docs/DropboxApi/Metadata/SharedFolder.html +165 -0
- data/docs/DropboxApi/Metadata/SharedFolderPolicy.html +156 -0
- data/docs/DropboxApi/Metadata/SharedLink.html +375 -0
- data/docs/DropboxApi/Metadata/SharedLinkMetadata.html +204 -0
- data/docs/DropboxApi/Metadata/SpaceAllocation.html +156 -0
- data/docs/DropboxApi/Metadata/SpaceUsage.html +159 -0
- data/docs/DropboxApi/Metadata/Tag.html +293 -0
- data/docs/DropboxApi/Metadata/Team.html +140 -0
- data/docs/DropboxApi/Metadata/TeamMemberInfo.html +160 -0
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +140 -0
- data/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +221 -0
- data/docs/DropboxApi/Metadata/UploadSessionCursor.html +226 -0
- data/docs/DropboxApi/Metadata/VideoMetadata.html +165 -0
- data/docs/DropboxApi/Metadata/WriteMode.html +439 -0
- data/docs/DropboxApi/MiddleWare.html +117 -0
- data/docs/DropboxApi/MiddleWare/DecodeResult.html +273 -0
- data/docs/DropboxApi/MiddleWare/Stack.html +452 -0
- data/docs/DropboxApi/OptionsValidator.html +234 -0
- data/docs/DropboxApi/ResultBuilder.html +570 -0
- data/docs/DropboxApi/Results.html +119 -0
- data/docs/DropboxApi/Results/AddFileMemberResultList.html +227 -0
- data/docs/DropboxApi/Results/Base.html +206 -0
- data/docs/DropboxApi/Results/BasicAccountBatch.html +205 -0
- data/docs/DropboxApi/Results/GetCopyReferenceResult.html +351 -0
- data/docs/DropboxApi/Results/GetTemporaryLinkResult.html +263 -0
- data/docs/DropboxApi/Results/GetThumbnailBatchResult.html +214 -0
- data/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +210 -0
- data/docs/DropboxApi/Results/ListFolderLongpollResult.html +287 -0
- data/docs/DropboxApi/Results/ListFolderResult.html +368 -0
- data/docs/DropboxApi/Results/ListRevisionsResult.html +300 -0
- data/docs/DropboxApi/Results/ListSharedLinksResult.html +368 -0
- data/docs/DropboxApi/Results/SaveCopyReferenceResult.html +221 -0
- data/docs/DropboxApi/Results/SaveUrlJobStatus.html +230 -0
- data/docs/DropboxApi/Results/SaveUrlResult.html +227 -0
- data/docs/DropboxApi/Results/Search.html +115 -0
- data/docs/DropboxApi/Results/Search/Match.html +314 -0
- data/docs/DropboxApi/Results/SearchResult.html +368 -0
- data/docs/DropboxApi/Results/ShareFolderLaunch.html +205 -0
- data/docs/DropboxApi/Results/SharedFileMembers.html +369 -0
- data/docs/DropboxApi/Results/SharedFolderMembers.html +369 -0
- data/docs/DropboxApi/Results/UploadSessionStart.html +210 -0
- data/docs/DropboxApi/Results/VoidResult.html +140 -0
- data/docs/DropboxScaffoldBuilder.html +1117 -0
- data/docs/_index.html +1984 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +4 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.README.html +257 -0
- data/docs/file.api_coverage.html +595 -0
- data/docs/file.rails_setup.html +152 -0
- data/docs/file_list.html +66 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +257 -0
- data/docs/js/app.js +292 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1779 -0
- data/docs/top-level-namespace.html +112 -0
- data/lib/dropbox_api/chunked_uploader.rb +1 -0
- data/lib/dropbox_api/version.rb +1 -1
- metadata +264 -2
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Module: DropboxApi::Endpoints::Files
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.15
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "DropboxApi::Endpoints::Files";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (F)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> » <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Files</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Module: DropboxApi::Endpoints::Files
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<dl>
|
|
80
|
+
<dt>Defined in:</dt>
|
|
81
|
+
<dd>lib/dropbox_api/endpoints/files/copy.rb<span class="defines">,<br />
|
|
82
|
+
lib/dropbox_api/endpoints/files/move.rb,<br /> lib/dropbox_api/endpoints/files/delete.rb,<br /> lib/dropbox_api/endpoints/files/search.rb,<br /> lib/dropbox_api/endpoints/files/upload.rb,<br /> lib/dropbox_api/endpoints/files/restore.rb,<br /> lib/dropbox_api/endpoints/files/download.rb,<br /> lib/dropbox_api/endpoints/files/save_url.rb,<br /> lib/dropbox_api/endpoints/files/get_preview.rb,<br /> lib/dropbox_api/endpoints/files/list_folder.rb,<br /> lib/dropbox_api/endpoints/files/get_metadata.rb,<br /> lib/dropbox_api/endpoints/files/create_folder.rb,<br /> lib/dropbox_api/endpoints/files/get_thumbnail.rb,<br /> lib/dropbox_api/endpoints/files/list_revisions.rb,<br /> lib/dropbox_api/endpoints/files/copy_reference_get.rb,<br /> lib/dropbox_api/endpoints/files/get_temporary_link.rb,<br /> lib/dropbox_api/endpoints/files/permanently_delete.rb,<br /> lib/dropbox_api/endpoints/files/copy_reference_save.rb,<br /> lib/dropbox_api/endpoints/files/get_thumbnail_batch.rb,<br /> lib/dropbox_api/endpoints/files/list_folder_continue.rb,<br /> lib/dropbox_api/endpoints/files/list_folder_longpoll.rb,<br /> lib/dropbox_api/endpoints/files/upload_session_start.rb,<br /> lib/dropbox_api/endpoints/files/upload_session_finish.rb,<br /> lib/dropbox_api/endpoints/files/upload_session_append_v2.rb,<br /> lib/dropbox_api/endpoints/files/save_url_check_job_status.rb,<br /> lib/dropbox_api/endpoints/file_requests/create_file_request.rb,<br /> lib/dropbox_api/endpoints/files/list_folder_get_latest_cursor.rb</span>
|
|
83
|
+
</dd>
|
|
84
|
+
</dl>
|
|
85
|
+
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
<h2>Defined Under Namespace</h2>
|
|
89
|
+
<p class="children">
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Files/Copy.html" title="DropboxApi::Endpoints::Files::Copy (class)">Copy</a></span>, <span class='object_link'><a href="Files/CopyReferenceGet.html" title="DropboxApi::Endpoints::Files::CopyReferenceGet (class)">CopyReferenceGet</a></span>, <span class='object_link'><a href="Files/CopyReferenceSave.html" title="DropboxApi::Endpoints::Files::CopyReferenceSave (class)">CopyReferenceSave</a></span>, <span class='object_link'><a href="Files/CreateFileRequest.html" title="DropboxApi::Endpoints::Files::CreateFileRequest (class)">CreateFileRequest</a></span>, <span class='object_link'><a href="Files/CreateFolder.html" title="DropboxApi::Endpoints::Files::CreateFolder (class)">CreateFolder</a></span>, <span class='object_link'><a href="Files/Delete.html" title="DropboxApi::Endpoints::Files::Delete (class)">Delete</a></span>, <span class='object_link'><a href="Files/Download.html" title="DropboxApi::Endpoints::Files::Download (class)">Download</a></span>, <span class='object_link'><a href="Files/GetMetadata.html" title="DropboxApi::Endpoints::Files::GetMetadata (class)">GetMetadata</a></span>, <span class='object_link'><a href="Files/GetPreview.html" title="DropboxApi::Endpoints::Files::GetPreview (class)">GetPreview</a></span>, <span class='object_link'><a href="Files/GetTemporaryLink.html" title="DropboxApi::Endpoints::Files::GetTemporaryLink (class)">GetTemporaryLink</a></span>, <span class='object_link'><a href="Files/GetThumbnail.html" title="DropboxApi::Endpoints::Files::GetThumbnail (class)">GetThumbnail</a></span>, <span class='object_link'><a href="Files/GetThumbnailBatch.html" title="DropboxApi::Endpoints::Files::GetThumbnailBatch (class)">GetThumbnailBatch</a></span>, <span class='object_link'><a href="Files/ListFolder.html" title="DropboxApi::Endpoints::Files::ListFolder (class)">ListFolder</a></span>, <span class='object_link'><a href="Files/ListFolderContinue.html" title="DropboxApi::Endpoints::Files::ListFolderContinue (class)">ListFolderContinue</a></span>, <span class='object_link'><a href="Files/ListFolderGetLatestCursor.html" title="DropboxApi::Endpoints::Files::ListFolderGetLatestCursor (class)">ListFolderGetLatestCursor</a></span>, <span class='object_link'><a href="Files/ListFolderLongpoll.html" title="DropboxApi::Endpoints::Files::ListFolderLongpoll (class)">ListFolderLongpoll</a></span>, <span class='object_link'><a href="Files/ListRevisions.html" title="DropboxApi::Endpoints::Files::ListRevisions (class)">ListRevisions</a></span>, <span class='object_link'><a href="Files/Move.html" title="DropboxApi::Endpoints::Files::Move (class)">Move</a></span>, <span class='object_link'><a href="Files/PermanentlyDelete.html" title="DropboxApi::Endpoints::Files::PermanentlyDelete (class)">PermanentlyDelete</a></span>, <span class='object_link'><a href="Files/Restore.html" title="DropboxApi::Endpoints::Files::Restore (class)">Restore</a></span>, <span class='object_link'><a href="Files/SaveUrl.html" title="DropboxApi::Endpoints::Files::SaveUrl (class)">SaveUrl</a></span>, <span class='object_link'><a href="Files/SaveUrlCheckJobStatus.html" title="DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus (class)">SaveUrlCheckJobStatus</a></span>, <span class='object_link'><a href="Files/Search.html" title="DropboxApi::Endpoints::Files::Search (class)">Search</a></span>, <span class='object_link'><a href="Files/Upload.html" title="DropboxApi::Endpoints::Files::Upload (class)">Upload</a></span>, <span class='object_link'><a href="Files/UploadSessionAppendV2.html" title="DropboxApi::Endpoints::Files::UploadSessionAppendV2 (class)">UploadSessionAppendV2</a></span>, <span class='object_link'><a href="Files/UploadSessionFinish.html" title="DropboxApi::Endpoints::Files::UploadSessionFinish (class)">UploadSessionFinish</a></span>, <span class='object_link'><a href="Files/UploadSessionStart.html" title="DropboxApi::Endpoints::Files::UploadSessionStart (class)">UploadSessionStart</a></span>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
</p>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
<div id="footer">
|
|
110
|
+
Generated on Mon Nov 12 20:42:55 2018 by
|
|
111
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
112
|
+
0.9.15 (ruby-2.3.3).
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</body>
|
|
117
|
+
</html>
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: DropboxApi::Endpoints::Files::Copy
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.15
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "DropboxApi::Endpoints::Files::Copy";
|
|
19
|
+
relpath = '../../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> » <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> » <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Copy</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: DropboxApi::Endpoints::Files::Copy
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
|
|
78
|
+
|
|
79
|
+
<li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
|
|
80
|
+
|
|
81
|
+
<li class="next">DropboxApi::Endpoints::Files::Copy</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<dl>
|
|
100
|
+
<dt>Defined in:</dt>
|
|
101
|
+
<dd>lib/dropbox_api/endpoints/files/copy.rb</dd>
|
|
102
|
+
</dl>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<h2>
|
|
109
|
+
Constant Summary
|
|
110
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
111
|
+
</h2>
|
|
112
|
+
|
|
113
|
+
<dl class="constants">
|
|
114
|
+
|
|
115
|
+
<dt id="Method-constant" class="">Method =
|
|
116
|
+
|
|
117
|
+
</dt>
|
|
118
|
+
<dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
|
|
119
|
+
|
|
120
|
+
<dt id="Path-constant" class="">Path =
|
|
121
|
+
|
|
122
|
+
</dt>
|
|
123
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/2/files/copy</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
124
|
+
|
|
125
|
+
<dt id="ResultType-constant" class="">ResultType =
|
|
126
|
+
|
|
127
|
+
</dt>
|
|
128
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/Resource.html" title="DropboxApi::Metadata::Resource (class)">Resource</a></span></span></pre></dd>
|
|
129
|
+
|
|
130
|
+
<dt id="ErrorType-constant" class="">ErrorType =
|
|
131
|
+
|
|
132
|
+
</dt>
|
|
133
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/RelocationError.html" title="DropboxApi::Errors::RelocationError (class)">RelocationError</a></span></span></pre></dd>
|
|
134
|
+
|
|
135
|
+
</dl>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<h2>
|
|
146
|
+
Instance Method Summary
|
|
147
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
148
|
+
</h2>
|
|
149
|
+
|
|
150
|
+
<ul class="summary">
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#copy-instance_method" title="#copy (instance method)">#<strong>copy</strong>(from, to) ⇒ Object </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'><p>Copy a file or folder to a different location in the user's Dropbox.</p>
|
|
170
|
+
</div></span>
|
|
171
|
+
|
|
172
|
+
</li>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
</ul>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
|
|
188
|
+
<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
|
|
199
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
|
|
200
|
+
<div id="constructor_details" class="method_details_list">
|
|
201
|
+
<h2>Constructor Details</h2>
|
|
202
|
+
|
|
203
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
|
|
204
|
+
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<div id="instance_method_details" class="method_details_list">
|
|
209
|
+
<h2>Instance Method Details</h2>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<div class="method_details first">
|
|
213
|
+
<h3 class="signature first" id="copy-instance_method">
|
|
214
|
+
|
|
215
|
+
#<strong>copy</strong>(from, to) ⇒ <tt>Object</tt>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
</h3><div class="docstring">
|
|
222
|
+
<div class="discussion">
|
|
223
|
+
<p>Copy a file or folder to a different location in the user's Dropbox.
|
|
224
|
+
If the source path is a folder all its contents will be copied.</p>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
</div>
|
|
228
|
+
</div>
|
|
229
|
+
<div class="tags">
|
|
230
|
+
<p class="tag_title">Parameters:</p>
|
|
231
|
+
<ul class="param">
|
|
232
|
+
|
|
233
|
+
<li>
|
|
234
|
+
|
|
235
|
+
<span class='name'>from</span>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
—
|
|
243
|
+
<div class='inline'><p>Path in the user's Dropbox to be copied or moved.</p>
|
|
244
|
+
</div>
|
|
245
|
+
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
<li>
|
|
249
|
+
|
|
250
|
+
<span class='name'>to</span>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
—
|
|
258
|
+
<div class='inline'><p>Path in the user's Dropbox that is the destination.</p>
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
</ul>
|
|
264
|
+
|
|
265
|
+
<p class="tag_title">Returns:</p>
|
|
266
|
+
<ul class="return">
|
|
267
|
+
|
|
268
|
+
<li>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<span class='type'></span>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<div class='inline'><p>The moved file.</p>
|
|
277
|
+
</div>
|
|
278
|
+
|
|
279
|
+
</li>
|
|
280
|
+
|
|
281
|
+
</ul>
|
|
282
|
+
|
|
283
|
+
</div>
|
|
284
|
+
<table class="source_code">
|
|
285
|
+
<tr>
|
|
286
|
+
<td>
|
|
287
|
+
<pre class="lines">
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
14
|
|
291
|
+
15
|
|
292
|
+
16
|
|
293
|
+
17
|
|
294
|
+
18
|
|
295
|
+
19</pre>
|
|
296
|
+
</td>
|
|
297
|
+
<td>
|
|
298
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy.rb', line 14</span>
|
|
299
|
+
|
|
300
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:copy</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_from'>from</span><span class='comma'>,</span> <span class='id identifier rubyid_to'>to</span><span class='op'>|</span>
|
|
301
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
302
|
+
<span class='symbol'>:from_path</span> <span class='op'>=></span> <span class='id identifier rubyid_from'>from</span><span class='comma'>,</span>
|
|
303
|
+
<span class='symbol'>:to_path</span> <span class='op'>=></span> <span class='id identifier rubyid_to'>to</span>
|
|
304
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
305
|
+
<span class='kw'>end</span></pre>
|
|
306
|
+
</td>
|
|
307
|
+
</tr>
|
|
308
|
+
</table>
|
|
309
|
+
</div>
|
|
310
|
+
|
|
311
|
+
</div>
|
|
312
|
+
|
|
313
|
+
</div>
|
|
314
|
+
|
|
315
|
+
<div id="footer">
|
|
316
|
+
Generated on Mon Nov 12 20:42:57 2018 by
|
|
317
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
318
|
+
0.9.15 (ruby-2.3.3).
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
</div>
|
|
322
|
+
</body>
|
|
323
|
+
</html>
|
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: DropboxApi::Endpoints::Files::CopyReferenceGet
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.15
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "DropboxApi::Endpoints::Files::CopyReferenceGet";
|
|
19
|
+
relpath = '../../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> » <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> » <span class='title'><span class='object_link'><a href="../Files.html" title="DropboxApi::Endpoints::Files (module)">Files</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">CopyReferenceGet</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: DropboxApi::Endpoints::Files::CopyReferenceGet
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next"><span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></li>
|
|
78
|
+
|
|
79
|
+
<li class="next"><span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></li>
|
|
80
|
+
|
|
81
|
+
<li class="next">DropboxApi::Endpoints::Files::CopyReferenceGet</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<dl>
|
|
100
|
+
<dt>Defined in:</dt>
|
|
101
|
+
<dd>lib/dropbox_api/endpoints/files/copy_reference_get.rb</dd>
|
|
102
|
+
</dl>
|
|
103
|
+
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
<h2>
|
|
109
|
+
Constant Summary
|
|
110
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
111
|
+
</h2>
|
|
112
|
+
|
|
113
|
+
<dl class="constants">
|
|
114
|
+
|
|
115
|
+
<dt id="Method-constant" class="">Method =
|
|
116
|
+
|
|
117
|
+
</dt>
|
|
118
|
+
<dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
|
|
119
|
+
|
|
120
|
+
<dt id="Path-constant" class="">Path =
|
|
121
|
+
|
|
122
|
+
</dt>
|
|
123
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/2/files/copy_reference/get</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
124
|
+
|
|
125
|
+
<dt id="ResultType-constant" class="">ResultType =
|
|
126
|
+
|
|
127
|
+
</dt>
|
|
128
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/GetCopyReferenceResult.html" title="DropboxApi::Results::GetCopyReferenceResult (class)">GetCopyReferenceResult</a></span></span></pre></dd>
|
|
129
|
+
|
|
130
|
+
<dt id="ErrorType-constant" class="">ErrorType =
|
|
131
|
+
|
|
132
|
+
</dt>
|
|
133
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/GetCopyReferenceError.html" title="DropboxApi::Errors::GetCopyReferenceError (class)">GetCopyReferenceError</a></span></span></pre></dd>
|
|
134
|
+
|
|
135
|
+
</dl>
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<h2>
|
|
146
|
+
Instance Method Summary
|
|
147
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
148
|
+
</h2>
|
|
149
|
+
|
|
150
|
+
<ul class="summary">
|
|
151
|
+
|
|
152
|
+
<li class="public ">
|
|
153
|
+
<span class="summary_signature">
|
|
154
|
+
|
|
155
|
+
<a href="#copy_reference_get-instance_method" title="#copy_reference_get (instance method)">#<strong>copy_reference_get</strong>(path) ⇒ DropboxApi::Results::GetCopyReferenceResult </a>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
</span>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'><p>Get a copy reference to a file or folder.</p>
|
|
170
|
+
</div></span>
|
|
171
|
+
|
|
172
|
+
</li>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
</ul>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
|
|
188
|
+
<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
|
|
199
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
|
|
200
|
+
<div id="constructor_details" class="method_details_list">
|
|
201
|
+
<h2>Constructor Details</h2>
|
|
202
|
+
|
|
203
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
|
|
204
|
+
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<div id="instance_method_details" class="method_details_list">
|
|
209
|
+
<h2>Instance Method Details</h2>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<div class="method_details first">
|
|
213
|
+
<h3 class="signature first" id="copy_reference_get-instance_method">
|
|
214
|
+
|
|
215
|
+
#<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>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
</h3><div class="docstring">
|
|
222
|
+
<div class="discussion">
|
|
223
|
+
<p>Get a copy reference to a file or folder.
|
|
224
|
+
This reference string can be used to save that file or folder
|
|
225
|
+
to another user's Dropbox by passing it to <span class='object_link'><a href="../../Client.html#copy_reference_save-instance_method" title="DropboxApi::Client#copy_reference_save (method)">Client#copy_reference_save</a></span>.</p>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</div>
|
|
229
|
+
</div>
|
|
230
|
+
<div class="tags">
|
|
231
|
+
<p class="tag_title">Parameters:</p>
|
|
232
|
+
<ul class="param">
|
|
233
|
+
|
|
234
|
+
<li>
|
|
235
|
+
|
|
236
|
+
<span class='name'>path</span>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
—
|
|
244
|
+
<div class='inline'><p>The path to the file or folder you want to get a
|
|
245
|
+
copy reference to.</p>
|
|
246
|
+
</div>
|
|
247
|
+
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
</ul>
|
|
251
|
+
|
|
252
|
+
<p class="tag_title">Returns:</p>
|
|
253
|
+
<ul class="return">
|
|
254
|
+
|
|
255
|
+
<li>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<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>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</li>
|
|
263
|
+
|
|
264
|
+
</ul>
|
|
265
|
+
|
|
266
|
+
</div>
|
|
267
|
+
<table class="source_code">
|
|
268
|
+
<tr>
|
|
269
|
+
<td>
|
|
270
|
+
<pre class="lines">
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
15
|
|
274
|
+
16
|
|
275
|
+
17
|
|
276
|
+
18
|
|
277
|
+
19</pre>
|
|
278
|
+
</td>
|
|
279
|
+
<td>
|
|
280
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/copy_reference_get.rb', line 15</span>
|
|
281
|
+
|
|
282
|
+
<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>
|
|
283
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
284
|
+
<span class='symbol'>:path</span> <span class='op'>=></span> <span class='id identifier rubyid_path'>path</span>
|
|
285
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
286
|
+
<span class='kw'>end</span></pre>
|
|
287
|
+
</td>
|
|
288
|
+
</tr>
|
|
289
|
+
</table>
|
|
290
|
+
</div>
|
|
291
|
+
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
</div>
|
|
295
|
+
|
|
296
|
+
<div id="footer">
|
|
297
|
+
Generated on Mon Nov 12 20:43:00 2018 by
|
|
298
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
299
|
+
0.9.15 (ruby-2.3.3).
|
|
300
|
+
</div>
|
|
301
|
+
|
|
302
|
+
</div>
|
|
303
|
+
</body>
|
|
304
|
+
</html>
|