Endpoints for creating and managing shared links and shared folders.
Summary
Functions
Adds specified members to a file. members is a list of MemberSelector
maps, e.g. %{".tag" => "email", "email" => "a@b.com"}; opts accepts
"custom_message", "quiet", "access_level" and
"add_message_as_comment".
Allows an owner/editor to add members to a shared folder. members is a
list of AddMember maps; opts accepts "quiet" and "custom_message".
Returns the status of an asynchronous sharing job.
Returns the status of an asynchronous member-removal job.
Returns the status of an asynchronous share-folder job.
Create a shared link with custom settings, returns a map.
Same as create_shared_link/3 but returns {:ok, %Magpie.SharedLink{}}.
Returns shared file metadata. file is a path or file id; opts accepts
"actions".
Returns shared file metadata for a batch of files.
Returns shared folder metadata. opts accepts "actions".
Download the shared link's file from a user's Dropbox. opts accepts
"path" and "link_password".
Get the metadata of a shared link. opts accepts "path" and
"link_password".
List the members of a file. opts accepts "actions",
"include_inherited" and "limit".
List the members of multiple files at once.
Fetches the next page of results from list_file_members/3.
List the members of a shared folder. opts accepts "actions" and
"limit".
Fetches the next page of results from list_folder_members/3.
Return the list of all shared folders the current user has access to.
opts accepts "limit" and "actions".
Fetches the next page of results from list_folders/2.
Returns a lazy Stream over all shared folders of the current user,
fetching pages through list_folders/2 + list_folders_continue/2 on
demand. Raises Magpie.Error if a page request fails.
Return the list of all shared folders the current user can mount or
unmount. opts accepts "limit" and "actions".
Fetches the next page of results from list_mountable_folders/2.
Returns a list of files shared with the current user. opts accepts
"limit" and "actions".
Fetches the next page of results from list_received_files/2.
List shared links of this user. opts accepts "path", "cursor" and
"direct_only".
Modify the settings of a shared link. settings takes the
SharedLinkSettings fields.
Mount a shared folder into the current user's Dropbox.
The current user relinquishes their access to a file by id.
The current user relinquishes their membership in a shared file.
The current user relinquishes their membership in a shared folder.
Removes a specified member from the file. member is a MemberSelector
map.
Removes a member from a shared folder. member is a MemberSelector map.
Revoke a shared link.
Sets the access inheritance of a shared folder ("inherit" or
"no_inherit").
Share a folder with collaborators. opts accepts the ShareFolderArg
fields ("acl_update_policy", "member_policy", "shared_link_policy",
"viewer_info_policy", "access_inheritance", "force_async", ...).
Transfer ownership of a shared folder to another member.
Unmount a shared folder from the current user's Dropbox.
Remove all members from this file (does not remove inherited membership).
Allows the owner to unshare a folder.
Changes a member's access on a shared file.
Changes the policies of a shared file. opts accepts "actions",
"link_settings" and "viewer_info_policy".
Changes a member's access on a shared folder.
Update the sharing policies for a shared folder. opts accepts
"member_policy", "acl_update_policy", "viewer_info_policy",
"shared_link_policy", "link_settings" and "actions".
Functions
Adds specified members to a file. members is a list of MemberSelector
maps, e.g. %{".tag" => "email", "email" => "a@b.com"}; opts accepts
"custom_message", "quiet", "access_level" and
"add_message_as_comment".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_file_member
Allows an owner/editor to add members to a shared folder. members is a
list of AddMember maps; opts accepts "quiet" and "custom_message".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-add_folder_member
Returns the status of an asynchronous sharing job.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_job_status
Returns the status of an asynchronous member-removal job.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-check_remove_member_job_status
Returns shared file metadata. file is a path or file id; opts accepts
"actions".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata
Returns shared file metadata for a batch of files.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_file_metadata-batch
Returns shared folder metadata. opts accepts "actions".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-get_folder_metadata
List the members of a file. opts accepts "actions",
"include_inherited" and "limit".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members
List the members of multiple files at once.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-batch
Fetches the next page of results from list_file_members/3.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_file_members-continue
List the members of a shared folder. opts accepts "actions" and
"limit".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members
Fetches the next page of results from list_folder_members/3.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folder_members-continue
Return the list of all shared folders the current user has access to.
opts accepts "limit" and "actions".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders
Fetches the next page of results from list_folders/2.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_folders-continue
Returns a lazy Stream over all shared folders of the current user,
fetching pages through list_folders/2 + list_folders_continue/2 on
demand. Raises Magpie.Error if a page request fails.
Example
client
|> Magpie.Sharing.list_folders_stream()
|> Enum.map(& &1["name"])Return the list of all shared folders the current user can mount or
unmount. opts accepts "limit" and "actions".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders
Fetches the next page of results from list_mountable_folders/2.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_mountable_folders-continue
Returns a list of files shared with the current user. opts accepts
"limit" and "actions".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files
Fetches the next page of results from list_received_files/2.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-list_received_files-continue
Mount a shared folder into the current user's Dropbox.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-mount_folder
The current user relinquishes their access to a file by id.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_access
The current user relinquishes their membership in a shared file.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_file_membership
The current user relinquishes their membership in a shared folder.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-relinquish_folder_membership
Removes a specified member from the file. member is a MemberSelector
map.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_file_member_2
Removes a member from a shared folder. member is a MemberSelector map.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-remove_folder_member
Sets the access inheritance of a shared folder ("inherit" or
"no_inherit").
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-set_access_inheritance
Transfer ownership of a shared folder to another member.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-transfer_folder
Unmount a shared folder from the current user's Dropbox.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-unmount_folder
Changes a member's access on a shared file.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_member
Changes the policies of a shared file. opts accepts "actions",
"link_settings" and "viewer_info_policy".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_file_policy
Changes a member's access on a shared folder.
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_member
Update the sharing policies for a shared folder. opts accepts
"member_policy", "acl_update_policy", "viewer_info_policy",
"shared_link_policy", "link_settings" and "actions".
More info at: https://www.dropbox.com/developers/documentation/http/documentation#sharing-update_folder_policy