Skip to main content

dropboxGetMetadata

Type​

command

Summary​

Returns the metadata for a file or folder.

Syntax​

dropboxGetMetadata <pAccessToken>, <pPath>, <pIncludeMediaInfo>, [<pCallback>]

Description​

note

Metadata for the root folder is unsupported.

If the path is a folder, then a folderMetadata json is returned. If the path is a file then a fileMetadata json is returned. If the path is a file or folder that has been deleted, then a deletedMetadata json is returned.

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

pPath

Path to a file or folder in the user's Dropbox to be queried

pIncludeMediaInfo

If true, FileMetadata.media_info is set for photo and video. The default for this field is False.

pCallback

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