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,350 @@
|
|
|
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::UploadSessionStart
|
|
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::UploadSessionStart";
|
|
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 (U)</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">UploadSessionStart</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::UploadSessionStart
|
|
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="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</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="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></li>
|
|
80
|
+
|
|
81
|
+
<li class="next">DropboxApi::Endpoints::Files::UploadSessionStart</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
<dl>
|
|
95
|
+
<dt>Includes:</dt>
|
|
96
|
+
<dd><span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></dd>
|
|
97
|
+
</dl>
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<dl>
|
|
105
|
+
<dt>Defined in:</dt>
|
|
106
|
+
<dd>lib/dropbox_api/endpoints/files/upload_session_start.rb</dd>
|
|
107
|
+
</dl>
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
<h2>
|
|
114
|
+
Constant Summary
|
|
115
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
116
|
+
</h2>
|
|
117
|
+
|
|
118
|
+
<dl class="constants">
|
|
119
|
+
|
|
120
|
+
<dt id="Method-constant" class="">Method =
|
|
121
|
+
|
|
122
|
+
</dt>
|
|
123
|
+
<dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
|
|
124
|
+
|
|
125
|
+
<dt id="Path-constant" class="">Path =
|
|
126
|
+
|
|
127
|
+
</dt>
|
|
128
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/2/files/upload_session/start</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
129
|
+
|
|
130
|
+
<dt id="ResultType-constant" class="">ResultType =
|
|
131
|
+
|
|
132
|
+
</dt>
|
|
133
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/UploadSessionStart.html" title="DropboxApi::Results::UploadSessionStart (class)">UploadSessionStart</a></span></span></pre></dd>
|
|
134
|
+
|
|
135
|
+
<dt id="ErrorType-constant" class="">ErrorType =
|
|
136
|
+
|
|
137
|
+
</dt>
|
|
138
|
+
<dd><pre class="code"><span class='kw'>nil</span></pre></dd>
|
|
139
|
+
|
|
140
|
+
</dl>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<h2>
|
|
151
|
+
Instance Method Summary
|
|
152
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
153
|
+
</h2>
|
|
154
|
+
|
|
155
|
+
<ul class="summary">
|
|
156
|
+
|
|
157
|
+
<li class="public ">
|
|
158
|
+
<span class="summary_signature">
|
|
159
|
+
|
|
160
|
+
<a href="#upload_session_start-instance_method" title="#upload_session_start (instance method)">#<strong>upload_session_start</strong>(content, options = {}) ⇒ DropboxApi::Metadata::UploadSessionCursor </a>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</span>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<span class="summary_desc"><div class='inline'><p>Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB.</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
|
|
193
|
+
<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ContentUpload.html" title="DropboxApi::Endpoints::ContentUpload (class)">ContentUpload</a></span></h3>
|
|
204
|
+
<p class="inherited"><span class='object_link'><a href="../ContentUpload.html#build_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../ContentUpload.html#initialize-instance_method" title="DropboxApi::Endpoints::ContentUpload#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../ContentUpload.html#perform_request-instance_method" title="DropboxApi::Endpoints::ContentUpload#perform_request (method)">#perform_request</a></span></p>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
|
|
215
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
|
|
216
|
+
<div id="constructor_details" class="method_details_list">
|
|
217
|
+
<h2>Constructor Details</h2>
|
|
218
|
+
|
|
219
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="../ContentUpload.html#initialize-instance_method" title="DropboxApi::Endpoints::ContentUpload#initialize (method)">DropboxApi::Endpoints::ContentUpload</a></span></p>
|
|
220
|
+
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<div id="instance_method_details" class="method_details_list">
|
|
225
|
+
<h2>Instance Method Details</h2>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<div class="method_details first">
|
|
229
|
+
<h3 class="signature first" id="upload_session_start-instance_method">
|
|
230
|
+
|
|
231
|
+
#<strong>upload_session_start</strong>(content, options = {}) ⇒ <tt><span class='object_link'><a href="../../Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</h3><div class="docstring">
|
|
238
|
+
<div class="discussion">
|
|
239
|
+
<p>Upload sessions allow you to upload a single file in one or more
|
|
240
|
+
requests, for example where the size of the file is greater than 150 MB.</p>
|
|
241
|
+
|
|
242
|
+
<p>This call starts a new upload session with the given data. You can then
|
|
243
|
+
use <span class='object_link'><a href="../../Client.html#upload_session_append_v2-instance_method" title="DropboxApi::Client#upload_session_append_v2 (method)">Client#upload_session_append_v2</a></span> to add more data and
|
|
244
|
+
<span class='object_link'><a href="../../Client.html#upload_session_finish-instance_method" title="DropboxApi::Client#upload_session_finish (method)">Client#upload_session_finish</a></span> to save all the data to a file in Dropbox.</p>
|
|
245
|
+
|
|
246
|
+
<p>A single request should not upload more than 150 MB of file contents.</p>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</div>
|
|
250
|
+
</div>
|
|
251
|
+
<div class="tags">
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
259
|
+
<ul class="option">
|
|
260
|
+
|
|
261
|
+
<li>
|
|
262
|
+
<span class="name">close</span>
|
|
263
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
264
|
+
<span class="default">
|
|
265
|
+
|
|
266
|
+
</span>
|
|
267
|
+
|
|
268
|
+
— <div class='inline'><p>If <code>true</code>, the current session will be
|
|
269
|
+
closed, at which point you won't be able to call
|
|
270
|
+
<span class='object_link'><a href="../../Client.html#upload_session_append_v2-instance_method" title="DropboxApi::Client#upload_session_append_v2 (method)">Client#upload_session_append_v2</a></span> anymore with the current session.
|
|
271
|
+
The default for this field is <code>false</code>.</p>
|
|
272
|
+
</div>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
</ul>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<p class="tag_title">Returns:</p>
|
|
280
|
+
<ul class="return">
|
|
281
|
+
|
|
282
|
+
<li>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<span class='type'>(<tt><span class='object_link'><a href="../../Metadata/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">DropboxApi::Metadata::UploadSessionCursor</a></span></tt>)</span>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
—
|
|
290
|
+
<div class='inline'><p>The session cursor
|
|
291
|
+
that you can use to continue the upload afterwards.</p>
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
</li>
|
|
295
|
+
|
|
296
|
+
</ul>
|
|
297
|
+
|
|
298
|
+
</div>
|
|
299
|
+
<table class="source_code">
|
|
300
|
+
<tr>
|
|
301
|
+
<td>
|
|
302
|
+
<pre class="lines">
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
25
|
|
306
|
+
26
|
|
307
|
+
27
|
|
308
|
+
28
|
|
309
|
+
29
|
|
310
|
+
30
|
|
311
|
+
31
|
|
312
|
+
32
|
|
313
|
+
33
|
|
314
|
+
34
|
|
315
|
+
35
|
|
316
|
+
36</pre>
|
|
317
|
+
</td>
|
|
318
|
+
<td>
|
|
319
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/files/upload_session_start.rb', line 25</span>
|
|
320
|
+
|
|
321
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:upload_session_start</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_content'>content</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>
|
|
322
|
+
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span>
|
|
323
|
+
<span class='symbol'>:close</span>
|
|
324
|
+
<span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
325
|
+
|
|
326
|
+
<span class='id identifier rubyid_session'>session</span> <span class='op'>=</span> <span class='id identifier rubyid_perform_request'>perform_request</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
|
|
327
|
+
|
|
328
|
+
<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/UploadSessionCursor.html" title="DropboxApi::Metadata::UploadSessionCursor (class)">UploadSessionCursor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Metadata/Base.html#initialize-instance_method" title="DropboxApi::Metadata::Base#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
329
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>session_id</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_session_id'>session_id</span><span class='comma'>,</span>
|
|
330
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>offset</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='id identifier rubyid_content'>content</span><span class='period'>.</span><span class='id identifier rubyid_bytesize'>bytesize</span>
|
|
331
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
332
|
+
<span class='kw'>end</span></pre>
|
|
333
|
+
</td>
|
|
334
|
+
</tr>
|
|
335
|
+
</table>
|
|
336
|
+
</div>
|
|
337
|
+
|
|
338
|
+
</div>
|
|
339
|
+
|
|
340
|
+
</div>
|
|
341
|
+
|
|
342
|
+
<div id="footer">
|
|
343
|
+
Generated on Mon Nov 12 20:43:00 2018 by
|
|
344
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
345
|
+
0.9.15 (ruby-2.3.3).
|
|
346
|
+
</div>
|
|
347
|
+
|
|
348
|
+
</div>
|
|
349
|
+
</body>
|
|
350
|
+
</html>
|
|
@@ -0,0 +1,353 @@
|
|
|
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::Rpc
|
|
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::Rpc";
|
|
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 (R)</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">Rpc</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::Rpc
|
|
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="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</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">DropboxApi::Endpoints::Rpc</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/dropbox_api/endpoints/rpc.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<div id="subclasses">
|
|
105
|
+
<h2>Direct Known Subclasses</h2>
|
|
106
|
+
<p class="children"><span class='object_link'><a href="Auth/TokenRevoke.html" title="DropboxApi::Endpoints::Auth::TokenRevoke (class)">Auth::TokenRevoke</a></span>, <span class='object_link'><a href="Files/Copy.html" title="DropboxApi::Endpoints::Files::Copy (class)">Files::Copy</a></span>, <span class='object_link'><a href="Files/CopyReferenceGet.html" title="DropboxApi::Endpoints::Files::CopyReferenceGet (class)">Files::CopyReferenceGet</a></span>, <span class='object_link'><a href="Files/CopyReferenceSave.html" title="DropboxApi::Endpoints::Files::CopyReferenceSave (class)">Files::CopyReferenceSave</a></span>, <span class='object_link'><a href="Files/CreateFileRequest.html" title="DropboxApi::Endpoints::Files::CreateFileRequest (class)">Files::CreateFileRequest</a></span>, <span class='object_link'><a href="Files/CreateFolder.html" title="DropboxApi::Endpoints::Files::CreateFolder (class)">Files::CreateFolder</a></span>, <span class='object_link'><a href="Files/Delete.html" title="DropboxApi::Endpoints::Files::Delete (class)">Files::Delete</a></span>, <span class='object_link'><a href="Files/GetMetadata.html" title="DropboxApi::Endpoints::Files::GetMetadata (class)">Files::GetMetadata</a></span>, <span class='object_link'><a href="Files/GetTemporaryLink.html" title="DropboxApi::Endpoints::Files::GetTemporaryLink (class)">Files::GetTemporaryLink</a></span>, <span class='object_link'><a href="Files/ListFolder.html" title="DropboxApi::Endpoints::Files::ListFolder (class)">Files::ListFolder</a></span>, <span class='object_link'><a href="Files/ListFolderContinue.html" title="DropboxApi::Endpoints::Files::ListFolderContinue (class)">Files::ListFolderContinue</a></span>, <span class='object_link'><a href="Files/ListFolderGetLatestCursor.html" title="DropboxApi::Endpoints::Files::ListFolderGetLatestCursor (class)">Files::ListFolderGetLatestCursor</a></span>, <span class='object_link'><a href="Files/ListRevisions.html" title="DropboxApi::Endpoints::Files::ListRevisions (class)">Files::ListRevisions</a></span>, <span class='object_link'><a href="Files/Move.html" title="DropboxApi::Endpoints::Files::Move (class)">Files::Move</a></span>, <span class='object_link'><a href="Files/PermanentlyDelete.html" title="DropboxApi::Endpoints::Files::PermanentlyDelete (class)">Files::PermanentlyDelete</a></span>, <span class='object_link'><a href="Files/Restore.html" title="DropboxApi::Endpoints::Files::Restore (class)">Files::Restore</a></span>, <span class='object_link'><a href="Files/SaveUrl.html" title="DropboxApi::Endpoints::Files::SaveUrl (class)">Files::SaveUrl</a></span>, <span class='object_link'><a href="Files/SaveUrlCheckJobStatus.html" title="DropboxApi::Endpoints::Files::SaveUrlCheckJobStatus (class)">Files::SaveUrlCheckJobStatus</a></span>, <span class='object_link'><a href="Files/Search.html" title="DropboxApi::Endpoints::Files::Search (class)">Files::Search</a></span>, <span class='object_link'><a href="RpcContent.html" title="DropboxApi::Endpoints::RpcContent (class)">RpcContent</a></span>, <span class='object_link'><a href="RpcNotify.html" title="DropboxApi::Endpoints::RpcNotify (class)">RpcNotify</a></span>, <span class='object_link'><a href="Sharing/AddFileMember.html" title="DropboxApi::Endpoints::Sharing::AddFileMember (class)">Sharing::AddFileMember</a></span>, <span class='object_link'><a href="Sharing/AddFolderMember.html" title="DropboxApi::Endpoints::Sharing::AddFolderMember (class)">Sharing::AddFolderMember</a></span>, <span class='object_link'><a href="Sharing/CreateSharedLinkWithSettings.html" title="DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings (class)">Sharing::CreateSharedLinkWithSettings</a></span>, <span class='object_link'><a href="Sharing/GetSharedLinkMetadata.html" title="DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata (class)">Sharing::GetSharedLinkMetadata</a></span>, <span class='object_link'><a href="Sharing/ListFileMembers.html" title="DropboxApi::Endpoints::Sharing::ListFileMembers (class)">Sharing::ListFileMembers</a></span>, <span class='object_link'><a href="Sharing/ListFolderMembers.html" title="DropboxApi::Endpoints::Sharing::ListFolderMembers (class)">Sharing::ListFolderMembers</a></span>, <span class='object_link'><a href="Sharing/ListSharedLinks.html" title="DropboxApi::Endpoints::Sharing::ListSharedLinks (class)">Sharing::ListSharedLinks</a></span>, <span class='object_link'><a href="Sharing/ShareFolder.html" title="DropboxApi::Endpoints::Sharing::ShareFolder (class)">Sharing::ShareFolder</a></span>, <span class='object_link'><a href="Sharing/UnshareFile.html" title="DropboxApi::Endpoints::Sharing::UnshareFile (class)">Sharing::UnshareFile</a></span>, <span class='object_link'><a href="Users/GetAccount.html" title="DropboxApi::Endpoints::Users::GetAccount (class)">Users::GetAccount</a></span>, <span class='object_link'><a href="Users/GetAccountBatch.html" title="DropboxApi::Endpoints::Users::GetAccountBatch (class)">Users::GetAccountBatch</a></span>, <span class='object_link'><a href="Users/GetCurrentAccount.html" title="DropboxApi::Endpoints::Users::GetCurrentAccount (class)">Users::GetCurrentAccount</a></span>, <span class='object_link'><a href="Users/GetSpaceUsage.html" title="DropboxApi::Endpoints::Users::GetSpaceUsage (class)">Users::GetSpaceUsage</a></span></p>
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<h2>
|
|
117
|
+
Instance Method Summary
|
|
118
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
119
|
+
</h2>
|
|
120
|
+
|
|
121
|
+
<ul class="summary">
|
|
122
|
+
|
|
123
|
+
<li class="public ">
|
|
124
|
+
<span class="summary_signature">
|
|
125
|
+
|
|
126
|
+
<a href="#build_request-instance_method" title="#build_request (instance method)">#<strong>build_request</strong>(params) ⇒ Object </a>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
</span>
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
141
|
+
|
|
142
|
+
</li>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<li class="public ">
|
|
146
|
+
<span class="summary_signature">
|
|
147
|
+
|
|
148
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(builder) ⇒ Rpc </a>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</span>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
<span class="note title constructor">constructor</span>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Rpc.</p>
|
|
165
|
+
</div></span>
|
|
166
|
+
|
|
167
|
+
</li>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#request_body-instance_method" title="#request_body (instance method)">#<strong>request_body</strong>(params) ⇒ Object </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
188
|
+
|
|
189
|
+
</li>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
</ul>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
|
|
205
|
+
<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>
|
|
206
|
+
<div id="constructor_details" class="method_details_list">
|
|
207
|
+
<h2>Constructor Details</h2>
|
|
208
|
+
|
|
209
|
+
<div class="method_details first">
|
|
210
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
211
|
+
|
|
212
|
+
#<strong>initialize</strong>(builder) ⇒ <tt><span class='object_link'><a href="" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></tt>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</h3><div class="docstring">
|
|
219
|
+
<div class="discussion">
|
|
220
|
+
<p>Returns a new instance of Rpc</p>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</div>
|
|
224
|
+
</div>
|
|
225
|
+
<div class="tags">
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
</div>
|
|
229
|
+
<table class="source_code">
|
|
230
|
+
<tr>
|
|
231
|
+
<td>
|
|
232
|
+
<pre class="lines">
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
3
|
|
236
|
+
4
|
|
237
|
+
5
|
|
238
|
+
6
|
|
239
|
+
7</pre>
|
|
240
|
+
</td>
|
|
241
|
+
<td>
|
|
242
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc.rb', line 3</span>
|
|
243
|
+
|
|
244
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_builder'>builder</span><span class='rparen'>)</span>
|
|
245
|
+
<span class='ivar'>@connection</span> <span class='op'>=</span> <span class='id identifier rubyid_builder'>builder</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>https://api.dropboxapi.com</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
|
|
246
|
+
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span> <span class='symbol'>:decode_result</span>
|
|
247
|
+
<span class='kw'>end</span>
|
|
248
|
+
<span class='kw'>end</span></pre>
|
|
249
|
+
</td>
|
|
250
|
+
</tr>
|
|
251
|
+
</table>
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
</div>
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<div id="instance_method_details" class="method_details_list">
|
|
258
|
+
<h2>Instance Method Details</h2>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<div class="method_details first">
|
|
262
|
+
<h3 class="signature first" id="build_request-instance_method">
|
|
263
|
+
|
|
264
|
+
#<strong>build_request</strong>(params) ⇒ <tt>Object</tt>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
</h3>
|
|
271
|
+
<table class="source_code">
|
|
272
|
+
<tr>
|
|
273
|
+
<td>
|
|
274
|
+
<pre class="lines">
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
9
|
|
278
|
+
10
|
|
279
|
+
11
|
|
280
|
+
12
|
|
281
|
+
13
|
|
282
|
+
14
|
|
283
|
+
15</pre>
|
|
284
|
+
</td>
|
|
285
|
+
<td>
|
|
286
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc.rb', line 9</span>
|
|
287
|
+
|
|
288
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_build_request'>build_request</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
289
|
+
<span class='id identifier rubyid_request_headers'>request_headers</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
290
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>content-type</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>application/json</span><span class='tstring_end'>'</span></span>
|
|
291
|
+
<span class='rbrace'>}</span>
|
|
292
|
+
|
|
293
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_request_body'>request_body</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
|
294
|
+
<span class='kw'>end</span></pre>
|
|
295
|
+
</td>
|
|
296
|
+
</tr>
|
|
297
|
+
</table>
|
|
298
|
+
</div>
|
|
299
|
+
|
|
300
|
+
<div class="method_details ">
|
|
301
|
+
<h3 class="signature " id="request_body-instance_method">
|
|
302
|
+
|
|
303
|
+
#<strong>request_body</strong>(params) ⇒ <tt>Object</tt>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
</h3>
|
|
310
|
+
<table class="source_code">
|
|
311
|
+
<tr>
|
|
312
|
+
<td>
|
|
313
|
+
<pre class="lines">
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
17
|
|
317
|
+
18
|
|
318
|
+
19
|
|
319
|
+
20
|
|
320
|
+
21
|
|
321
|
+
22
|
|
322
|
+
23
|
|
323
|
+
24</pre>
|
|
324
|
+
</td>
|
|
325
|
+
<td>
|
|
326
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/rpc.rb', line 17</span>
|
|
327
|
+
|
|
328
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_request_body'>request_body</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
329
|
+
<span class='comment'># This check is only required for compatibility with old JSON serializers
|
|
330
|
+
</span> <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
331
|
+
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>null</span><span class='tstring_end'>'</span></span>
|
|
332
|
+
<span class='kw'>else</span>
|
|
333
|
+
<span class='const'>JSON</span><span class='period'>.</span><span class='id identifier rubyid_dump'>dump</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
|
|
334
|
+
<span class='kw'>end</span>
|
|
335
|
+
<span class='kw'>end</span></pre>
|
|
336
|
+
</td>
|
|
337
|
+
</tr>
|
|
338
|
+
</table>
|
|
339
|
+
</div>
|
|
340
|
+
|
|
341
|
+
</div>
|
|
342
|
+
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
<div id="footer">
|
|
346
|
+
Generated on Mon Nov 12 20:42:56 2018 by
|
|
347
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
348
|
+
0.9.15 (ruby-2.3.3).
|
|
349
|
+
</div>
|
|
350
|
+
|
|
351
|
+
</div>
|
|
352
|
+
</body>
|
|
353
|
+
</html>
|