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.
Files changed (268) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -1
  3. data/.yardopts +1 -0
  4. data/docs/DropboxApi.html +135 -0
  5. data/docs/DropboxApi/Authenticator.html +217 -0
  6. data/docs/DropboxApi/ChunkedUploader.html +409 -0
  7. data/docs/DropboxApi/Client.html +8747 -0
  8. data/docs/DropboxApi/ConnectionBuilder.html +326 -0
  9. data/docs/DropboxApi/Endpoints.html +119 -0
  10. data/docs/DropboxApi/Endpoints/Auth.html +115 -0
  11. data/docs/DropboxApi/Endpoints/Auth/TokenRevoke.html +265 -0
  12. data/docs/DropboxApi/Endpoints/Base.html +197 -0
  13. data/docs/DropboxApi/Endpoints/ContentDownload.html +383 -0
  14. data/docs/DropboxApi/Endpoints/ContentUpload.html +351 -0
  15. data/docs/DropboxApi/Endpoints/Files.html +117 -0
  16. data/docs/DropboxApi/Endpoints/Files/Copy.html +323 -0
  17. data/docs/DropboxApi/Endpoints/Files/CopyReferenceGet.html +304 -0
  18. data/docs/DropboxApi/Endpoints/Files/CopyReferenceSave.html +320 -0
  19. data/docs/DropboxApi/Endpoints/Files/CreateFileRequest.html +307 -0
  20. data/docs/DropboxApi/Endpoints/Files/CreateFolder.html +305 -0
  21. data/docs/DropboxApi/Endpoints/Files/Delete.html +341 -0
  22. data/docs/DropboxApi/Endpoints/Files/Download.html +284 -0
  23. data/docs/DropboxApi/Endpoints/Files/GetMetadata.html +376 -0
  24. data/docs/DropboxApi/Endpoints/Files/GetPreview.html +286 -0
  25. data/docs/DropboxApi/Endpoints/Files/GetTemporaryLink.html +286 -0
  26. data/docs/DropboxApi/Endpoints/Files/GetThumbnail.html +388 -0
  27. data/docs/DropboxApi/Endpoints/Files/GetThumbnailBatch.html +431 -0
  28. data/docs/DropboxApi/Endpoints/Files/ListFolder.html +383 -0
  29. data/docs/DropboxApi/Endpoints/Files/ListFolderContinue.html +298 -0
  30. data/docs/DropboxApi/Endpoints/Files/ListFolderGetLatestCursor.html +371 -0
  31. data/docs/DropboxApi/Endpoints/Files/ListFolderLongpoll.html +360 -0
  32. data/docs/DropboxApi/Endpoints/Files/ListRevisions.html +338 -0
  33. data/docs/DropboxApi/Endpoints/Files/Move.html +364 -0
  34. data/docs/DropboxApi/Endpoints/Files/PermanentlyDelete.html +337 -0
  35. data/docs/DropboxApi/Endpoints/Files/Restore.html +305 -0
  36. data/docs/DropboxApi/Endpoints/Files/SaveUrl.html +324 -0
  37. data/docs/DropboxApi/Endpoints/Files/SaveUrlCheckJobStatus.html +306 -0
  38. data/docs/DropboxApi/Endpoints/Files/Search.html +399 -0
  39. data/docs/DropboxApi/Endpoints/Files/Upload.html +439 -0
  40. data/docs/DropboxApi/Endpoints/Files/UploadSessionAppendV2.html +377 -0
  41. data/docs/DropboxApi/Endpoints/Files/UploadSessionFinish.html +328 -0
  42. data/docs/DropboxApi/Endpoints/Files/UploadSessionStart.html +350 -0
  43. data/docs/DropboxApi/Endpoints/Rpc.html +353 -0
  44. data/docs/DropboxApi/Endpoints/RpcContent.html +236 -0
  45. data/docs/DropboxApi/Endpoints/RpcNotify.html +240 -0
  46. data/docs/DropboxApi/Endpoints/Sharing.html +117 -0
  47. data/docs/DropboxApi/Endpoints/Sharing/AddFileMember.html +415 -0
  48. data/docs/DropboxApi/Endpoints/Sharing/AddFolderMember.html +400 -0
  49. data/docs/DropboxApi/Endpoints/Sharing/CreateSharedLinkWithSettings.html +322 -0
  50. data/docs/DropboxApi/Endpoints/Sharing/GetSharedLinkMetadata.html +344 -0
  51. data/docs/DropboxApi/Endpoints/Sharing/ListFileMembers.html +421 -0
  52. data/docs/DropboxApi/Endpoints/Sharing/ListFolderMembers.html +400 -0
  53. data/docs/DropboxApi/Endpoints/Sharing/ListSharedLinks.html +345 -0
  54. data/docs/DropboxApi/Endpoints/Sharing/ShareFolder.html +428 -0
  55. data/docs/DropboxApi/Endpoints/Sharing/UnshareFile.html +290 -0
  56. data/docs/DropboxApi/Endpoints/Users.html +117 -0
  57. data/docs/DropboxApi/Endpoints/Users/GetAccount.html +301 -0
  58. data/docs/DropboxApi/Endpoints/Users/GetAccountBatch.html +303 -0
  59. data/docs/DropboxApi/Endpoints/Users/GetCurrentAccount.html +282 -0
  60. data/docs/DropboxApi/Endpoints/Users/GetSpaceUsage.html +282 -0
  61. data/docs/DropboxApi/Errors.html +117 -0
  62. data/docs/DropboxApi/Errors/AddFileMemberError.html +164 -0
  63. data/docs/DropboxApi/Errors/AddFolderMemberError.html +170 -0
  64. data/docs/DropboxApi/Errors/AddMemberSelectorError.html +165 -0
  65. data/docs/DropboxApi/Errors/AlreadySharedError.html +213 -0
  66. data/docs/DropboxApi/Errors/BadPathError.html +143 -0
  67. data/docs/DropboxApi/Errors/BasicError.html +356 -0
  68. data/docs/DropboxApi/Errors/CantCopySharedFolderError.html +143 -0
  69. data/docs/DropboxApi/Errors/CantMoveFolderIntoItselfError.html +143 -0
  70. data/docs/DropboxApi/Errors/CantNestSharedFolderError.html +143 -0
  71. data/docs/DropboxApi/Errors/CantShareOutsideTeamError.html +143 -0
  72. data/docs/DropboxApi/Errors/ContainsSharedFolderError.html +143 -0
  73. data/docs/DropboxApi/Errors/ConversionError.html +143 -0
  74. data/docs/DropboxApi/Errors/CreateFileRequestError.html +160 -0
  75. data/docs/DropboxApi/Errors/CreateFolderError.html +161 -0
  76. data/docs/DropboxApi/Errors/CreateSharedLinkWithSettingsError.html +165 -0
  77. data/docs/DropboxApi/Errors/CursorClosedError.html +143 -0
  78. data/docs/DropboxApi/Errors/CursorNotClosedError.html +143 -0
  79. data/docs/DropboxApi/Errors/DeleteError.html +162 -0
  80. data/docs/DropboxApi/Errors/DisallowedNameError.html +143 -0
  81. data/docs/DropboxApi/Errors/DisallowedSharedLinkPolicyError.html +143 -0
  82. data/docs/DropboxApi/Errors/DownloadError.html +161 -0
  83. data/docs/DropboxApi/Errors/DownloadFailedError.html +143 -0
  84. data/docs/DropboxApi/Errors/EmailUnverifiedError.html +143 -0
  85. data/docs/DropboxApi/Errors/FileAncestorConflictError.html +143 -0
  86. data/docs/DropboxApi/Errors/FileConflictError.html +143 -0
  87. data/docs/DropboxApi/Errors/FileMemberActionError.html +164 -0
  88. data/docs/DropboxApi/Errors/FolderConflictError.html +143 -0
  89. data/docs/DropboxApi/Errors/GetAccountError.html +161 -0
  90. data/docs/DropboxApi/Errors/GetCopyReferenceError.html +161 -0
  91. data/docs/DropboxApi/Errors/GetMetadataError.html +161 -0
  92. data/docs/DropboxApi/Errors/GroupDeletedError.html +143 -0
  93. data/docs/DropboxApi/Errors/GroupNotOnTeamError.html +143 -0
  94. data/docs/DropboxApi/Errors/HttpError.html +124 -0
  95. data/docs/DropboxApi/Errors/InProgressError.html +143 -0
  96. data/docs/DropboxApi/Errors/InsideAppFolderError.html +143 -0
  97. data/docs/DropboxApi/Errors/InsideOsxPackageError.html +143 -0
  98. data/docs/DropboxApi/Errors/InsidePublicFolderError.html +143 -0
  99. data/docs/DropboxApi/Errors/InsideSharedFolderError.html +143 -0
  100. data/docs/DropboxApi/Errors/InsufficientPlanError.html +143 -0
  101. data/docs/DropboxApi/Errors/InsufficientSpaceError.html +143 -0
  102. data/docs/DropboxApi/Errors/InternalError.html +143 -0
  103. data/docs/DropboxApi/Errors/InvalidCommentError.html +143 -0
  104. data/docs/DropboxApi/Errors/InvalidCopyReferenceError.html +143 -0
  105. data/docs/DropboxApi/Errors/InvalidCursorError.html +143 -0
  106. data/docs/DropboxApi/Errors/InvalidDropboxIdError.html +143 -0
  107. data/docs/DropboxApi/Errors/InvalidEmailError.html +143 -0
  108. data/docs/DropboxApi/Errors/InvalidFileError.html +143 -0
  109. data/docs/DropboxApi/Errors/InvalidIdError.html +143 -0
  110. data/docs/DropboxApi/Errors/InvalidMemberError.html +143 -0
  111. data/docs/DropboxApi/Errors/InvalidPathError.html +143 -0
  112. data/docs/DropboxApi/Errors/InvalidRevisionError.html +143 -0
  113. data/docs/DropboxApi/Errors/InvalidSettingsError.html +143 -0
  114. data/docs/DropboxApi/Errors/InvalidUrlError.html +143 -0
  115. data/docs/DropboxApi/Errors/IsAppFolderError.html +143 -0
  116. data/docs/DropboxApi/Errors/IsFileError.html +143 -0
  117. data/docs/DropboxApi/Errors/IsFolderError.html +143 -0
  118. data/docs/DropboxApi/Errors/IsOsxPackageError.html +143 -0
  119. data/docs/DropboxApi/Errors/IsPublicFolderError.html +143 -0
  120. data/docs/DropboxApi/Errors/ListFolderContinueError.html +162 -0
  121. data/docs/DropboxApi/Errors/ListFolderError.html +161 -0
  122. data/docs/DropboxApi/Errors/ListFolderLongpollError.html +161 -0
  123. data/docs/DropboxApi/Errors/ListRevisionsError.html +161 -0
  124. data/docs/DropboxApi/Errors/ListSharedLinksError.html +162 -0
  125. data/docs/DropboxApi/Errors/LookupError.html +165 -0
  126. data/docs/DropboxApi/Errors/MalformedPathError.html +143 -0
  127. data/docs/DropboxApi/Errors/NoAccountError.html +143 -0
  128. data/docs/DropboxApi/Errors/NoPermissionError.html +143 -0
  129. data/docs/DropboxApi/Errors/NoWritePermissionError.html +143 -0
  130. data/docs/DropboxApi/Errors/NotAMemberError.html +143 -0
  131. data/docs/DropboxApi/Errors/NotFileError.html +143 -0
  132. data/docs/DropboxApi/Errors/NotFolderError.html +143 -0
  133. data/docs/DropboxApi/Errors/NotFoundError.html +143 -0
  134. data/docs/DropboxApi/Errors/PollError.html +162 -0
  135. data/docs/DropboxApi/Errors/PreviewError.html +164 -0
  136. data/docs/DropboxApi/Errors/RateLimitError.html +143 -0
  137. data/docs/DropboxApi/Errors/RelocationError.html +167 -0
  138. data/docs/DropboxApi/Errors/RestoreError.html +163 -0
  139. data/docs/DropboxApi/Errors/RestrictedContentError.html +143 -0
  140. data/docs/DropboxApi/Errors/SaveCopyReferenceError.html +165 -0
  141. data/docs/DropboxApi/Errors/SaveUrlError.html +164 -0
  142. data/docs/DropboxApi/Errors/SearchError.html +161 -0
  143. data/docs/DropboxApi/Errors/SettingsError.html +162 -0
  144. data/docs/DropboxApi/Errors/ShareFolderError.html +165 -0
  145. data/docs/DropboxApi/Errors/SharePathError.html +171 -0
  146. data/docs/DropboxApi/Errors/SharedFolderAccessError.html +164 -0
  147. data/docs/DropboxApi/Errors/SharedLinkAccessDeniedError.html +143 -0
  148. data/docs/DropboxApi/Errors/SharedLinkAlreadyExistsError.html +143 -0
  149. data/docs/DropboxApi/Errors/SharedLinkError.html +163 -0
  150. data/docs/DropboxApi/Errors/SharedLinkNotFoundError.html +143 -0
  151. data/docs/DropboxApi/Errors/SharingFileAccessError.html +165 -0
  152. data/docs/DropboxApi/Errors/SharingUserError.html +161 -0
  153. data/docs/DropboxApi/Errors/TeamFolderError.html +143 -0
  154. data/docs/DropboxApi/Errors/TeamPolicyDisallowsMemberPolicyError.html +143 -0
  155. data/docs/DropboxApi/Errors/ThumbnailBatchError.html +161 -0
  156. data/docs/DropboxApi/Errors/ThumbnailError.html +164 -0
  157. data/docs/DropboxApi/Errors/TooManyFilesError.html +143 -0
  158. data/docs/DropboxApi/Errors/TooManyMembersError.html +143 -0
  159. data/docs/DropboxApi/Errors/TooManyPendingInvitesError.html +143 -0
  160. data/docs/DropboxApi/Errors/TooManyRequestsError.html +321 -0
  161. data/docs/DropboxApi/Errors/TooManySharedFolderTargetsError.html +143 -0
  162. data/docs/DropboxApi/Errors/TooManyWriteOperationsError.html +167 -0
  163. data/docs/DropboxApi/Errors/UnmountedError.html +143 -0
  164. data/docs/DropboxApi/Errors/UnshareFileError.html +162 -0
  165. data/docs/DropboxApi/Errors/UnsupportedContentError.html +143 -0
  166. data/docs/DropboxApi/Errors/UnsupportedExtensionError.html +143 -0
  167. data/docs/DropboxApi/Errors/UnsupportedImageError.html +143 -0
  168. data/docs/DropboxApi/Errors/UnsupportedLinkTypeError.html +143 -0
  169. data/docs/DropboxApi/Errors/UnverifiedDropboxId.html +143 -0
  170. data/docs/DropboxApi/Errors/UploadError.html +161 -0
  171. data/docs/DropboxApi/Errors/UploadSessionFinishError.html +163 -0
  172. data/docs/DropboxApi/Errors/UploadSessionLookupError.html +164 -0
  173. data/docs/DropboxApi/Errors/UploadSessionOffsetError.html +220 -0
  174. data/docs/DropboxApi/Errors/UploadWriteFailedError.html +161 -0
  175. data/docs/DropboxApi/Errors/WriteConflictError.html +163 -0
  176. data/docs/DropboxApi/Errors/WriteError.html +165 -0
  177. data/docs/DropboxApi/Metadata.html +117 -0
  178. data/docs/DropboxApi/Metadata/AccessLevel.html +259 -0
  179. data/docs/DropboxApi/Metadata/AddFileMemberResult.html +164 -0
  180. data/docs/DropboxApi/Metadata/AddMember.html +246 -0
  181. data/docs/DropboxApi/Metadata/Base.html +545 -0
  182. data/docs/DropboxApi/Metadata/BasicAccount.html +167 -0
  183. data/docs/DropboxApi/Metadata/CommitInfo.html +232 -0
  184. data/docs/DropboxApi/Metadata/Deleted.html +158 -0
  185. data/docs/DropboxApi/Metadata/Dimensions.html +140 -0
  186. data/docs/DropboxApi/Metadata/Field.html +358 -0
  187. data/docs/DropboxApi/Metadata/File.html +238 -0
  188. data/docs/DropboxApi/Metadata/FileLinkMetadata.html +180 -0
  189. data/docs/DropboxApi/Metadata/FileMemberAction.html +230 -0
  190. data/docs/DropboxApi/Metadata/FileRequest.html +167 -0
  191. data/docs/DropboxApi/Metadata/Folder.html +228 -0
  192. data/docs/DropboxApi/Metadata/FolderLinkMetadata.html +140 -0
  193. data/docs/DropboxApi/Metadata/FolderSharingInfo.html +156 -0
  194. data/docs/DropboxApi/Metadata/LinkPermissions.html +161 -0
  195. data/docs/DropboxApi/Metadata/Location.html +140 -0
  196. data/docs/DropboxApi/Metadata/MediaInfo.html +245 -0
  197. data/docs/DropboxApi/Metadata/MediaMetadata.html +237 -0
  198. data/docs/DropboxApi/Metadata/Member.html +313 -0
  199. data/docs/DropboxApi/Metadata/MemberAction.html +274 -0
  200. data/docs/DropboxApi/Metadata/MemberActionList.html +221 -0
  201. data/docs/DropboxApi/Metadata/MemberPermission.html +163 -0
  202. data/docs/DropboxApi/Metadata/MemberPermissionList.html +237 -0
  203. data/docs/DropboxApi/Metadata/Name.html +158 -0
  204. data/docs/DropboxApi/Metadata/ParentFolderAccessInfo.html +140 -0
  205. data/docs/DropboxApi/Metadata/PhotoMetadata.html +164 -0
  206. data/docs/DropboxApi/Metadata/Resource.html +207 -0
  207. data/docs/DropboxApi/Metadata/SharedFolder.html +165 -0
  208. data/docs/DropboxApi/Metadata/SharedFolderPolicy.html +156 -0
  209. data/docs/DropboxApi/Metadata/SharedLink.html +375 -0
  210. data/docs/DropboxApi/Metadata/SharedLinkMetadata.html +204 -0
  211. data/docs/DropboxApi/Metadata/SpaceAllocation.html +156 -0
  212. data/docs/DropboxApi/Metadata/SpaceUsage.html +159 -0
  213. data/docs/DropboxApi/Metadata/Tag.html +293 -0
  214. data/docs/DropboxApi/Metadata/Team.html +140 -0
  215. data/docs/DropboxApi/Metadata/TeamMemberInfo.html +160 -0
  216. data/docs/DropboxApi/Metadata/ThumbnailBatchResultData.html +140 -0
  217. data/docs/DropboxApi/Metadata/ThumbnailBatchResultEntry.html +221 -0
  218. data/docs/DropboxApi/Metadata/UploadSessionCursor.html +226 -0
  219. data/docs/DropboxApi/Metadata/VideoMetadata.html +165 -0
  220. data/docs/DropboxApi/Metadata/WriteMode.html +439 -0
  221. data/docs/DropboxApi/MiddleWare.html +117 -0
  222. data/docs/DropboxApi/MiddleWare/DecodeResult.html +273 -0
  223. data/docs/DropboxApi/MiddleWare/Stack.html +452 -0
  224. data/docs/DropboxApi/OptionsValidator.html +234 -0
  225. data/docs/DropboxApi/ResultBuilder.html +570 -0
  226. data/docs/DropboxApi/Results.html +119 -0
  227. data/docs/DropboxApi/Results/AddFileMemberResultList.html +227 -0
  228. data/docs/DropboxApi/Results/Base.html +206 -0
  229. data/docs/DropboxApi/Results/BasicAccountBatch.html +205 -0
  230. data/docs/DropboxApi/Results/GetCopyReferenceResult.html +351 -0
  231. data/docs/DropboxApi/Results/GetTemporaryLinkResult.html +263 -0
  232. data/docs/DropboxApi/Results/GetThumbnailBatchResult.html +214 -0
  233. data/docs/DropboxApi/Results/ListFolderGetLatestCursorResult.html +210 -0
  234. data/docs/DropboxApi/Results/ListFolderLongpollResult.html +287 -0
  235. data/docs/DropboxApi/Results/ListFolderResult.html +368 -0
  236. data/docs/DropboxApi/Results/ListRevisionsResult.html +300 -0
  237. data/docs/DropboxApi/Results/ListSharedLinksResult.html +368 -0
  238. data/docs/DropboxApi/Results/SaveCopyReferenceResult.html +221 -0
  239. data/docs/DropboxApi/Results/SaveUrlJobStatus.html +230 -0
  240. data/docs/DropboxApi/Results/SaveUrlResult.html +227 -0
  241. data/docs/DropboxApi/Results/Search.html +115 -0
  242. data/docs/DropboxApi/Results/Search/Match.html +314 -0
  243. data/docs/DropboxApi/Results/SearchResult.html +368 -0
  244. data/docs/DropboxApi/Results/ShareFolderLaunch.html +205 -0
  245. data/docs/DropboxApi/Results/SharedFileMembers.html +369 -0
  246. data/docs/DropboxApi/Results/SharedFolderMembers.html +369 -0
  247. data/docs/DropboxApi/Results/UploadSessionStart.html +210 -0
  248. data/docs/DropboxApi/Results/VoidResult.html +140 -0
  249. data/docs/DropboxScaffoldBuilder.html +1117 -0
  250. data/docs/_index.html +1984 -0
  251. data/docs/class_list.html +51 -0
  252. data/docs/css/common.css +4 -0
  253. data/docs/css/full_list.css +58 -0
  254. data/docs/css/style.css +496 -0
  255. data/docs/file.README.html +257 -0
  256. data/docs/file.api_coverage.html +595 -0
  257. data/docs/file.rails_setup.html +152 -0
  258. data/docs/file_list.html +66 -0
  259. data/docs/frames.html +17 -0
  260. data/docs/index.html +257 -0
  261. data/docs/js/app.js +292 -0
  262. data/docs/js/full_list.js +216 -0
  263. data/docs/js/jquery.js +4 -0
  264. data/docs/method_list.html +1779 -0
  265. data/docs/top-level-namespace.html +112 -0
  266. data/lib/dropbox_api/chunked_uploader.rb +1 -0
  267. data/lib/dropbox_api/version.rb +1 -1
  268. metadata +264 -2
@@ -0,0 +1,117 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: DropboxApi::Endpoints::Sharing
8
+
9
+ &mdash; 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";
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 (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span>
41
+ &raquo;
42
+ <span class="title">Sharing</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: DropboxApi::Endpoints::Sharing
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/dropbox_api/endpoints/sharing/share_folder.rb<span class="defines">,<br />
82
+ lib/dropbox_api/endpoints/sharing/unshare_file.rb,<br /> lib/dropbox_api/endpoints/sharing/add_file_member.rb,<br /> lib/dropbox_api/endpoints/sharing/add_folder_member.rb,<br /> lib/dropbox_api/endpoints/sharing/list_file_members.rb,<br /> lib/dropbox_api/endpoints/sharing/list_shared_links.rb,<br /> lib/dropbox_api/endpoints/sharing/list_folder_members.rb,<br /> lib/dropbox_api/endpoints/sharing/get_shared_link_metadata.rb,<br /> lib/dropbox_api/endpoints/sharing/create_shared_link_with_settings.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Defined Under Namespace</h2>
89
+ <p class="children">
90
+
91
+
92
+
93
+
94
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Sharing/AddFileMember.html" title="DropboxApi::Endpoints::Sharing::AddFileMember (class)">AddFileMember</a></span>, <span class='object_link'><a href="Sharing/AddFolderMember.html" title="DropboxApi::Endpoints::Sharing::AddFolderMember (class)">AddFolderMember</a></span>, <span class='object_link'><a href="Sharing/CreateSharedLinkWithSettings.html" title="DropboxApi::Endpoints::Sharing::CreateSharedLinkWithSettings (class)">CreateSharedLinkWithSettings</a></span>, <span class='object_link'><a href="Sharing/GetSharedLinkMetadata.html" title="DropboxApi::Endpoints::Sharing::GetSharedLinkMetadata (class)">GetSharedLinkMetadata</a></span>, <span class='object_link'><a href="Sharing/ListFileMembers.html" title="DropboxApi::Endpoints::Sharing::ListFileMembers (class)">ListFileMembers</a></span>, <span class='object_link'><a href="Sharing/ListFolderMembers.html" title="DropboxApi::Endpoints::Sharing::ListFolderMembers (class)">ListFolderMembers</a></span>, <span class='object_link'><a href="Sharing/ListSharedLinks.html" title="DropboxApi::Endpoints::Sharing::ListSharedLinks (class)">ListSharedLinks</a></span>, <span class='object_link'><a href="Sharing/ShareFolder.html" title="DropboxApi::Endpoints::Sharing::ShareFolder (class)">ShareFolder</a></span>, <span class='object_link'><a href="Sharing/UnshareFile.html" title="DropboxApi::Endpoints::Sharing::UnshareFile (class)">UnshareFile</a></span>
95
+
96
+
97
+ </p>
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ </div>
108
+
109
+ <div id="footer">
110
+ Generated on Mon Nov 12 20:42:55 2018 by
111
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
+ 0.9.15 (ruby-2.3.3).
113
+ </div>
114
+
115
+ </div>
116
+ </body>
117
+ </html>
@@ -0,0 +1,415 @@
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::AddFileMember
8
+
9
+ &mdash; 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::AddFileMember";
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 (A)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Endpoints.html" title="DropboxApi::Endpoints (module)">Endpoints</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sharing.html" title="DropboxApi::Endpoints::Sharing (module)">Sharing</a></span></span>
41
+ &raquo;
42
+ <span class="title">AddFileMember</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::AddFileMember
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::AddFileMember</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/add_file_member.rb</dd>
107
+ </dl>
108
+
109
+ </div>
110
+
111
+
112
+
113
+ <h2>
114
+ Constant Summary
115
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
116
+ </h2>
117
+
118
+ <dl class="constants">
119
+
120
+ <dt id="Method-constant" class="">Method =
121
+
122
+ </dt>
123
+ <dd><pre class="code"><span class='symbol'>:post</span></pre></dd>
124
+
125
+ <dt id="Path-constant" class="">Path =
126
+
127
+ </dt>
128
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/2/sharing/add_file_member</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
129
+
130
+ <dt id="ResultType-constant" class="">ResultType =
131
+
132
+ </dt>
133
+ <dd><pre class="code"><span class='const'><span class='object_link'><a href="../../../DropboxApi.html" title="DropboxApi (module)">DropboxApi</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results.html" title="DropboxApi::Results (module)">Results</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Results/AddFileMemberResultList.html" title="DropboxApi::Results::AddFileMemberResultList (class)">AddFileMemberResultList</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/AddFileMemberError.html" title="DropboxApi::Errors::AddFileMemberError (class)">AddFileMemberError</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="#add_file_member-instance_method" title="#add_file_member (instance method)">#<strong>add_file_member</strong>(file, members, options = {}) &#x21d2; Object </a>
161
+
162
+
163
+
164
+ </span>
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'><p>Adds specified members to a file.</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="add_file_member-instance_method">
230
+
231
+ #<strong>add_file_member</strong>(file, members, options = {}) &#x21d2; <tt>Object</tt>
232
+
233
+
234
+
235
+
236
+
237
+ </h3><div class="docstring">
238
+ <div class="discussion">
239
+ <p>Adds specified members to a file.</p>
240
+
241
+ <p>The <code>members</code> parameter can be an <code>Array</code> or a single member element. Each
242
+ element is represented by either a <code>String</code> or a <span class='object_link'><a href="../../Metadata/Member.html" title="DropboxApi::Metadata::Member (class)">Metadata::Member</a></span>
243
+ object. You can identify a member using his email or a Dropbox ID.</p>
244
+
245
+
246
+ </div>
247
+ </div>
248
+ <div class="tags">
249
+ <p class="tag_title">Parameters:</p>
250
+ <ul class="param">
251
+
252
+ <li>
253
+
254
+ <span class='name'>file</span>
255
+
256
+
257
+ <span class='type'>(<tt>String</tt>)</span>
258
+
259
+
260
+
261
+ &mdash;
262
+ <div class='inline'><p>File to which to add members. It can be a path or
263
+ an ID such as <code>id:3kmLmQFnf1AAAAAAAAAAAw</code>.</p>
264
+ </div>
265
+
266
+ </li>
267
+
268
+ <li>
269
+
270
+ <span class='name'>members</span>
271
+
272
+
273
+ <span class='type'></span>
274
+
275
+
276
+
277
+ &mdash;
278
+ <div class='inline'><p>Members to add. Note
279
+ that even if an email address is given, this may result in a user
280
+ being directy added to the membership if that email is the user&#39;s
281
+ main account email.</p>
282
+ </div>
283
+
284
+ </li>
285
+
286
+ </ul>
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+ <p class="tag_title">Options Hash (<tt>options</tt>):</p>
296
+ <ul class="option">
297
+
298
+ <li>
299
+ <span class="name">quiet</span>
300
+ <span class="type">(<tt>Boolean</tt>)</span>
301
+ <span class="default">
302
+
303
+ </span>
304
+
305
+ &mdash; <div class='inline'><p>Whether added members should be notified
306
+ via email and device notifications of their invite. The default for
307
+ this field is <code>false</code>.</p>
308
+ </div>
309
+
310
+ </li>
311
+
312
+ <li>
313
+ <span class="name">custom_message</span>
314
+ <span class="type">(<tt>String</tt>)</span>
315
+ <span class="default">
316
+
317
+ </span>
318
+
319
+ &mdash; <div class='inline'><p>Message to send to added members
320
+ in their invitation. This field is optional.</p>
321
+ </div>
322
+
323
+ </li>
324
+
325
+ <li>
326
+ <span class="name">access_level</span>
327
+ <span class="type">(<tt>AccessLevel</tt>)</span>
328
+ <span class="default">
329
+
330
+ </span>
331
+
332
+ &mdash; <div class='inline'><p>AccessLevel union object,
333
+ describing what access level we want to give new members. The default
334
+ for this is <code>:viewer</code>.</p>
335
+ </div>
336
+
337
+ </li>
338
+
339
+ <li>
340
+ <span class="name">add_message_as_comment</span>
341
+ <span class="type">(<tt>String</tt>)</span>
342
+ <span class="default">
343
+
344
+ </span>
345
+
346
+ &mdash; <div class='inline'><p>Optional message to
347
+ display to added members in their invitation. This field is optional.</p>
348
+ </div>
349
+
350
+ </li>
351
+
352
+ </ul>
353
+
354
+
355
+
356
+ <p class="tag_title">See Also:</p>
357
+ <ul class="see">
358
+
359
+ <li><span class='object_link'><a href="../../Metadata/Member.html" title="DropboxApi::Metadata::Member (class)">Metadata::Member</a></span></li>
360
+
361
+ </ul>
362
+
363
+ </div>
364
+ <table class="source_code">
365
+ <tr>
366
+ <td>
367
+ <pre class="lines">
368
+
369
+
370
+ 33
371
+ 34
372
+ 35
373
+ 36
374
+ 37
375
+ 38
376
+ 39
377
+ 40
378
+ 41
379
+ 42
380
+ 43
381
+ 44</pre>
382
+ </td>
383
+ <td>
384
+ <pre class="code"><span class="info file"># File 'lib/dropbox_api/endpoints/sharing/add_file_member.rb', line 33</span>
385
+
386
+ <span class='id identifier rubyid_add_endpoint'>add_endpoint</span> <span class='symbol'>:add_file_member</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='comma'>,</span> <span class='id identifier rubyid_members'>members</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>
387
+ <span class='id identifier rubyid_validate_options'>validate_options</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='comma'>,</span> <span class='symbol'>:custom_message</span><span class='comma'>,</span> <span class='symbol'>:access_level</span><span class='comma'>,</span> <span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
388
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:quiet</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
389
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:custom_message</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>nil</span>
390
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:access_level</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:viewer</span>
391
+ <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:add_message_as_comment</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='kw'>false</span>
392
+
393
+ <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>
394
+ <span class='symbol'>:file</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_file'>file</span><span class='comma'>,</span>
395
+ <span class='symbol'>:members</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_build_members_param'>build_members_param</span><span class='lparen'>(</span><span class='id identifier rubyid_members'>members</span><span class='rparen'>)</span>
396
+ <span class='rbrace'>}</span><span class='rparen'>)</span>
397
+ <span class='kw'>end</span></pre>
398
+ </td>
399
+ </tr>
400
+ </table>
401
+ </div>
402
+
403
+ </div>
404
+
405
+ </div>
406
+
407
+ <div id="footer">
408
+ Generated on Mon Nov 12 20:43:00 2018 by
409
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
410
+ 0.9.15 (ruby-2.3.3).
411
+ </div>
412
+
413
+ </div>
414
+ </body>
415
+ </html>