Skip to main content

dropboxGetFolderMetadata

Type​

command

Summary​

Returns shared folder metadata by its folder ID.

Syntax​

dropboxGetFolderMetadata <pAccessToken>, <pSharedFolderId>, [<pActions>, <pCallback>]

Description​

Apps must have full Dropbox access to use this endpoint.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters​

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pSharedFolderID

The ID for the shared folder.

pActions

This is a return delimited list indicating whether the returned folder data will include a boolean value FolderPermission.allow that describes whether the current user can perform the folder action on the folder. This field is optional.

Actions that may be taken on shared folders. The value will be one of the following datatypes. New values may be introduced as our API evolves.

  • "change_options": Change folder options, such as who can be invited to join the folder.
  • "edit_contents": Change or edit contents of the folder.
  • "invite_editor": Invite a user or group to join the folder with read and write permission.
  • "invite_viewer": Invite a user or group to join the folder with read permission.
  • "invite_viewer_no_comment": Invite a user or group to join the folder with read permission but no comment permissions.
  • "relinquish_membership": Relinquish one's own membership in the folder.
  • "unmount": Unmount the folder.
  • "unshare": Stop sharing this folder.
  • "leave_a_copy": Keep a copy of the contents upon leaving or being kicked from the folder.
  • "share_link": This action is deprecated. Use create_link instead.
  • "create_link": Create a shared link for folder.

pCallback

The handler to call when the request is complete. If empty the command will block until complete.