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,344 @@
|
|
|
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::Sharing::GetSharedLinkMetadata
|
|
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::Sharing::GetSharedLinkMetadata";
|
|
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 (G)</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="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">GetSharedLinkMetadata</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::Sharing::GetSharedLinkMetadata
|
|
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::Sharing::GetSharedLinkMetadata</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/sharing/get_shared_link_metadata.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/sharing/get_shared_link_metadata</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="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/SharedLinkMetadata.html" title="DropboxApi::Metadata::SharedLinkMetadata (class)">SharedLinkMetadata</a></span></span></pre></dd>
|
|
134
|
+
|
|
135
|
+
<dt id="ErrorType-constant" class="">ErrorType =
|
|
136
|
+
|
|
137
|
+
</dt>
|
|
138
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SharedLinkError.html" title="DropboxApi::Errors::SharedLinkError (class)">SharedLinkError</a></span></span></pre></dd>
|
|
139
|
+
|
|
140
|
+
</dl>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<h2>
|
|
151
|
+
Instance Method Summary
|
|
152
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
153
|
+
</h2>
|
|
154
|
+
|
|
155
|
+
<ul class="summary">
|
|
156
|
+
|
|
157
|
+
<li class="public ">
|
|
158
|
+
<span class="summary_signature">
|
|
159
|
+
|
|
160
|
+
<a href="#get_shared_link_metadata-instance_method" title="#get_shared_link_metadata (instance method)">#<strong>get_shared_link_metadata</strong>(preview_link, options = {}) ⇒ SharedFileMembers </a>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</span>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<span class="summary_desc"><div class='inline'><p>Get the Metadata for a shared link.</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
|
|
193
|
+
<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
|
|
204
|
+
<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
|
|
215
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
|
|
216
|
+
<div id="constructor_details" class="method_details_list">
|
|
217
|
+
<h2>Constructor Details</h2>
|
|
218
|
+
|
|
219
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
|
|
220
|
+
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<div id="instance_method_details" class="method_details_list">
|
|
225
|
+
<h2>Instance Method Details</h2>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<div class="method_details first">
|
|
229
|
+
<h3 class="signature first" id="get_shared_link_metadata-instance_method">
|
|
230
|
+
|
|
231
|
+
#<strong>get_shared_link_metadata</strong>(preview_link, options = {}) ⇒ <tt>SharedFileMembers</tt>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</h3><div class="docstring">
|
|
238
|
+
<div class="discussion">
|
|
239
|
+
<p>Get the Metadata for a shared link</p>
|
|
240
|
+
|
|
241
|
+
<p>If a preview url is given, returns the shared file or folder
|
|
242
|
+
that is represent by that link.</p>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
</div>
|
|
246
|
+
</div>
|
|
247
|
+
<div class="tags">
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
255
|
+
<ul class="option">
|
|
256
|
+
|
|
257
|
+
<li>
|
|
258
|
+
<span class="name">path</span>
|
|
259
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
260
|
+
<span class="default">
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
— <div class='inline'><p>If the shared link is to a folder,
|
|
265
|
+
this parameter can be used to retrieve the metadata for a
|
|
266
|
+
specific file or sub-folder in this folder. A relative path
|
|
267
|
+
should be used.</p>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
</li>
|
|
271
|
+
|
|
272
|
+
<li>
|
|
273
|
+
<span class="name">link_password</span>
|
|
274
|
+
<span class="type">(<tt>String</tt>)</span>
|
|
275
|
+
<span class="default">
|
|
276
|
+
|
|
277
|
+
</span>
|
|
278
|
+
|
|
279
|
+
— <div class='inline'><p>If the shared link has
|
|
280
|
+
a password, this parameter can be used.</p>
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
</li>
|
|
284
|
+
|
|
285
|
+
</ul>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<p class="tag_title">Returns:</p>
|
|
289
|
+
<ul class="return">
|
|
290
|
+
|
|
291
|
+
<li>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class='type'>(<tt>SharedFileMembers</tt>)</span>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
</li>
|
|
299
|
+
|
|
300
|
+
</ul>
|
|
301
|
+
|
|
302
|
+
</div>
|
|
303
|
+
<table class="source_code">
|
|
304
|
+
<tr>
|
|
305
|
+
<td>
|
|
306
|
+
<pre class="lines">
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
22
|
|
310
|
+
23
|
|
311
|
+
24
|
|
312
|
+
25
|
|
313
|
+
26
|
|
314
|
+
27
|
|
315
|
+
28</pre>
|
|
316
|
+
</td>
|
|
317
|
+
<td>
|
|
318
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb', line 22</span>
|
|
319
|
+
|
|
320
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:get_shared_link_metadata</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_preview_link'>preview_link</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>
|
|
321
|
+
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='comma'>,</span> <span class='symbol'>:link_password</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
322
|
+
|
|
323
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span>
|
|
324
|
+
<span class='symbol'>:url</span> <span class='op'>=></span> <span class='id identifier rubyid_preview_link'>preview_link</span>
|
|
325
|
+
<span class='rparen'>)</span>
|
|
326
|
+
<span class='kw'>end</span></pre>
|
|
327
|
+
</td>
|
|
328
|
+
</tr>
|
|
329
|
+
</table>
|
|
330
|
+
</div>
|
|
331
|
+
|
|
332
|
+
</div>
|
|
333
|
+
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
<div id="footer">
|
|
337
|
+
Generated on Mon Nov 12 20:43:01 2018 by
|
|
338
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
339
|
+
0.9.15 (ruby-2.3.3).
|
|
340
|
+
</div>
|
|
341
|
+
|
|
342
|
+
</div>
|
|
343
|
+
</body>
|
|
344
|
+
</html>
|
|
@@ -0,0 +1,421 @@
|
|
|
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::Sharing::ListFileMembers
|
|
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::Sharing::ListFileMembers";
|
|
19
|
+
relpath = '../../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../../_index.html">Index (L)</a> »
|
|
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="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">ListFileMembers</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::Sharing::ListFileMembers
|
|
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::Sharing::ListFileMembers</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/sharing/list_file_members.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/sharing/list_file_members</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/SharedFileMembers.html" title="DropboxApi::Results::SharedFileMembers (class)">SharedFileMembers</a></span></span></pre></dd>
|
|
134
|
+
|
|
135
|
+
<dt id="ErrorType-constant" class="">ErrorType =
|
|
136
|
+
|
|
137
|
+
</dt>
|
|
138
|
+
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors.html" title="DropboxApi::Errors (module)">Errors</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Errors/SharingFileAccessError.html" title="DropboxApi::Errors::SharingFileAccessError (class)">SharingFileAccessError</a></span></span></pre></dd>
|
|
139
|
+
|
|
140
|
+
</dl>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<h2>
|
|
151
|
+
Instance Method Summary
|
|
152
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
153
|
+
</h2>
|
|
154
|
+
|
|
155
|
+
<ul class="summary">
|
|
156
|
+
|
|
157
|
+
<li class="public ">
|
|
158
|
+
<span class="summary_signature">
|
|
159
|
+
|
|
160
|
+
<a href="#list_file_members-instance_method" title="#list_file_members (instance method)">#<strong>list_file_members</strong>(file_id, actions = [], options = {}) ⇒ SharedFileMembers </a>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
</span>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<span class="summary_desc"><div class='inline'><p>Use to obtain the members who have been invited to a file, both inherited and uninherited members.</p>
|
|
175
|
+
</div></span>
|
|
176
|
+
|
|
177
|
+
</li>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../../OptionsValidator.html" title="DropboxApi::OptionsValidator (module)">OptionsValidator</a></span></h3>
|
|
193
|
+
<p class="inherited"><span class='object_link'><a href="../../OptionsValidator.html#validate_options-instance_method" title="DropboxApi::OptionsValidator#validate_options (method)">#validate_options</a></span></p>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Rpc.html" title="DropboxApi::Endpoints::Rpc (class)">Rpc</a></span></h3>
|
|
204
|
+
<p class="inherited"><span class='object_link'><a href="../Rpc.html#build_request-instance_method" title="DropboxApi::Endpoints::Rpc#build_request (method)">#build_request</a></span>, <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Rpc.html#request_body-instance_method" title="DropboxApi::Endpoints::Rpc#request_body (method)">#request_body</a></span></p>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Base.html" title="DropboxApi::Endpoints::Base (class)">Base</a></span></h3>
|
|
215
|
+
<p class="inherited"><span class='object_link'><a href="../Base.html#add_endpoint-class_method" title="DropboxApi::Endpoints::Base.add_endpoint (method)">add_endpoint</a></span></p>
|
|
216
|
+
<div id="constructor_details" class="method_details_list">
|
|
217
|
+
<h2>Constructor Details</h2>
|
|
218
|
+
|
|
219
|
+
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Rpc.html#initialize-instance_method" title="DropboxApi::Endpoints::Rpc#initialize (method)">DropboxApi::Endpoints::Rpc</a></span></p>
|
|
220
|
+
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<div id="instance_method_details" class="method_details_list">
|
|
225
|
+
<h2>Instance Method Details</h2>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<div class="method_details first">
|
|
229
|
+
<h3 class="signature first" id="list_file_members-instance_method">
|
|
230
|
+
|
|
231
|
+
#<strong>list_file_members</strong>(file_id, actions = [], options = {}) ⇒ <tt>SharedFileMembers</tt>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</h3><div class="docstring">
|
|
238
|
+
<div class="discussion">
|
|
239
|
+
<p>Use to obtain the members who have been invited to a file, both
|
|
240
|
+
inherited and uninherited members.</p>
|
|
241
|
+
|
|
242
|
+
<p>Apps must have full Dropbox access to use this endpoint.</p>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
</div>
|
|
246
|
+
</div>
|
|
247
|
+
<div class="tags">
|
|
248
|
+
|
|
249
|
+
<div class="examples">
|
|
250
|
+
<p class="tag_title">Examples:</p>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<p class="example_title"><div class='inline'><p>List file members.</p>
|
|
254
|
+
</div></p>
|
|
255
|
+
|
|
256
|
+
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>"</span></span></code></pre>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
<p class="example_title"><div class='inline'><p>List file members, with detail of permission to make owner.</p>
|
|
260
|
+
</div></p>
|
|
261
|
+
|
|
262
|
+
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1231273663</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:make_owner</span><span class='rbracket'>]</span></code></pre>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<p class="example_title"><div class='inline'><p>List file members, using the path instead of file ID.</p>
|
|
266
|
+
</div></p>
|
|
267
|
+
|
|
268
|
+
<pre class="example code"><code><span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_list_file_members'>list_file_members</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/my/file.pdf</span><span class='tstring_end'>"</span></span></code></pre>
|
|
269
|
+
|
|
270
|
+
</div>
|
|
271
|
+
<p class="tag_title">Parameters:</p>
|
|
272
|
+
<ul class="param">
|
|
273
|
+
|
|
274
|
+
<li>
|
|
275
|
+
|
|
276
|
+
<span class='name'>file_id</span>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
—
|
|
284
|
+
<div class='inline'><p>The ID for the shared file.</p>
|
|
285
|
+
</div>
|
|
286
|
+
|
|
287
|
+
</li>
|
|
288
|
+
|
|
289
|
+
<li>
|
|
290
|
+
|
|
291
|
+
<span class='name'>actions</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class='type'>(<tt>Array</tt>)</span>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
—
|
|
301
|
+
<div class='inline'><p>This is an optional list of actions. The permissions for the actions
|
|
302
|
+
requested will be included in the result.</p>
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
</li>
|
|
306
|
+
|
|
307
|
+
</ul>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
317
|
+
<ul class="option">
|
|
318
|
+
|
|
319
|
+
<li>
|
|
320
|
+
<span class="name">include_inherited</span>
|
|
321
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
|
322
|
+
<span class="default">
|
|
323
|
+
|
|
324
|
+
</span>
|
|
325
|
+
|
|
326
|
+
— <div class='inline'><p>Whether to include members
|
|
327
|
+
who only have access from a parent shared folder. The default for this
|
|
328
|
+
field is <code>true</code>.</p>
|
|
329
|
+
</div>
|
|
330
|
+
|
|
331
|
+
</li>
|
|
332
|
+
|
|
333
|
+
<li>
|
|
334
|
+
<span class="name">limit</span>
|
|
335
|
+
<span class="type">(<tt>Numeric</tt>)</span>
|
|
336
|
+
<span class="default">
|
|
337
|
+
|
|
338
|
+
</span>
|
|
339
|
+
|
|
340
|
+
— <div class='inline'><p>The maximum number of results that
|
|
341
|
+
include members, groups and invitees to return per request. The default
|
|
342
|
+
for this field is 100.</p>
|
|
343
|
+
</div>
|
|
344
|
+
|
|
345
|
+
</li>
|
|
346
|
+
|
|
347
|
+
</ul>
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
<p class="tag_title">Returns:</p>
|
|
351
|
+
<ul class="return">
|
|
352
|
+
|
|
353
|
+
<li>
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
<span class='type'>(<tt>SharedFileMembers</tt>)</span>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
—
|
|
361
|
+
<div class='inline'><p>Shared file user and group membership.</p>
|
|
362
|
+
</div>
|
|
363
|
+
|
|
364
|
+
</li>
|
|
365
|
+
|
|
366
|
+
</ul>
|
|
367
|
+
|
|
368
|
+
<p class="tag_title">See Also:</p>
|
|
369
|
+
<ul class="see">
|
|
370
|
+
|
|
371
|
+
<li><span class='object_link'><a href="../../Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">Metadata::MemberActionList</a></span></li>
|
|
372
|
+
|
|
373
|
+
</ul>
|
|
374
|
+
|
|
375
|
+
</div>
|
|
376
|
+
<table class="source_code">
|
|
377
|
+
<tr>
|
|
378
|
+
<td>
|
|
379
|
+
<pre class="lines">
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
36
|
|
383
|
+
37
|
|
384
|
+
38
|
|
385
|
+
39
|
|
386
|
+
40
|
|
387
|
+
41
|
|
388
|
+
42
|
|
389
|
+
43
|
|
390
|
+
44</pre>
|
|
391
|
+
</td>
|
|
392
|
+
<td>
|
|
393
|
+
<pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/list_file_members.rb', line 36</span>
|
|
394
|
+
|
|
395
|
+
<span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:list_file_members</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_file_id'>file_id</span><span class='comma'>,</span> <span class='id identifier rubyid_actions'>actions</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</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>
|
|
396
|
+
<span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='comma'>,</span> <span class='symbol'>:include_inherited</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
|
|
397
|
+
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:limit</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='int'>100</span>
|
|
398
|
+
|
|
399
|
+
<span class='id identifier rubyid_perform_request'>perform_request</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
400
|
+
<span class='symbol'>:file</span> <span class='op'>=></span> <span class='id identifier rubyid_file_id'>file_id</span><span class='comma'>,</span>
|
|
401
|
+
<span class='symbol'>:actions</span> <span class='op'>=></span> <span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata.html" title="DropboxApi::Metadata (module)">Metadata</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Metadata/MemberActionList.html" title="DropboxApi::Metadata::MemberActionList (class)">MemberActionList</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../../Metadata/MemberActionList.html#initialize-instance_method" title="DropboxApi::Metadata::MemberActionList#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_actions'>actions</span><span class='rparen'>)</span>
|
|
402
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
403
|
+
<span class='kw'>end</span></pre>
|
|
404
|
+
</td>
|
|
405
|
+
</tr>
|
|
406
|
+
</table>
|
|
407
|
+
</div>
|
|
408
|
+
|
|
409
|
+
</div>
|
|
410
|
+
|
|
411
|
+
</div>
|
|
412
|
+
|
|
413
|
+
<div id="footer">
|
|
414
|
+
Generated on Mon Nov 12 20:43:00 2018 by
|
|
415
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
416
|
+
0.9.15 (ruby-2.3.3).
|
|
417
|
+
</div>
|
|
418
|
+
|
|
419
|
+
</div>
|
|
420
|
+
</body>
|
|
421
|
+
</html>
|