Class: DropboxApi::Endpoints::Sharing::AddFolderMember
- Includes:
- OptionsValidator
- Defined in:
- lib/dropbox_api/endpoints/sharing/add_folder_member.rb
Constant Summary collapse
- Method =
:post
- Path =
"/2/sharing/add_folder_member".freeze
- ResultType =
DropboxApi::Results::VoidResult
- ErrorType =
DropboxApi::Errors::AddFolderMemberError
Instance Method Summary collapse
-
#add_folder_member(folder_id, members, options = {}) ⇒ Object
Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.
Methods included from OptionsValidator
Methods inherited from Rpc
Methods inherited from Base
Constructor Details
This class inherits a constructor from DropboxApi::Endpoints::Rpc
Instance Method Details
#add_folder_member(folder_id, members, options = {}) ⇒ Object
Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.
For the new member to get access to all the functionality for this folder, you will need to call mount_folder on their behalf.
Apps must have full Dropbox access to use this endpoint.
The members
parameter must be an Array. Each item in the array could be either a String or a Metadata::AddMember object.
31 32 33 34 35 36 37 38 39 40 |
# File 'lib/dropbox_api/endpoints/sharing/add_folder_member.rb', line 31 add_endpoint :add_folder_member do |folder_id, members, = {}| ([:quiet, :custom_message], ) [:quiet] ||= false [:custom_message] ||= nil perform_request .merge({ :shared_folder_id => folder_id, :members => build_members_param(members) }) end |