Class: DropboxApi::Endpoints::Sharing::ListFolderMembers

Inherits:
Rpc
  • Object
show all
Includes:
OptionsValidator
Defined in:
lib/dropbox_api/endpoints/sharing/list_folder_members.rb

Constant Summary collapse

Method = 
:post
Path = 
"/2/sharing/list_folder_members".freeze
ResultType = 
DropboxApi::Results::SharedFolderMembers
ErrorType = 
DropboxApi::Errors::SharedFolderAccessError

Instance Method Summary collapse

Methods included from OptionsValidator

#validate_options

Methods inherited from Rpc

#build_request, #initialize

Methods inherited from Base

add_endpoint

Constructor Details

This class inherits a constructor from DropboxApi::Endpoints::Rpc

Instance Method Details

#list_folder_members(folder_id, actions, options) ⇒ SharedFolderMembers

Returns shared folder membership by its folder ID.

Apps must have full Dropbox access to use this endpoint.

Parameters:

  • folder_id (String) —

    The ID for the shared folder.

Returns:

  • (SharedFolderMembers) —

    Shared folder user and group membership.



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/dropbox_api/endpoints/sharing/list_folder_members.rb', line 20

add_endpoint :list_folder_members do |folder_id, options = {}|
  # NOTE: This endpoint accepts an additional option `actions` which hasn't
  #       been implemented.
  validate_options([:limit], options)
  options[:limit] ||= 100

  perform_request options.merge({
    :shared_folder_id => folder_id
  })
end