ObjC 3.3.5 new(ish) parameters for listFolder method

Mark R.5

I have just updated the SDK and there are 3 new parameters in the listFolder: method. However the documentation does not really go into much detail (and the last parameter is not mentioned at all):

 

listFolder:recursive:includeMediaInfo:includeDeleted:includeHasExplicitSharedMembers:includeMountedFolders:limit:sharedLink

 

Can you please clarify the following:

 

1) What does the includeMountedFolders flag do exactly?

2) The limit is presumably a way of setting when listFolderContinue will be called?

3) What does sharedLink refer to?

Greg-DB

Thanks for the report! I'll ask the team to fix the documentation.

 

1) includeMountedFolders: "If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder."

 

That is, whether or not to have the Dropbox API return information about those types of folders and their children in the listFolder (and listFolderContinue) responses. So, if you set includeMountedFolders=false, the listed entries will not include shared folders, etc.

 

2) limit: "The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases."

 

This controls how many entries are returned per page, i.e., per single response from listFolder/listFolderContinue. This is useful if the user has many files and you would prefer to have your app list them out in smaller batches.

 

3) sharedLink: "A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, ListFolderArg.path will be relative to root of the shared link. Only non-recursive mode is supported for shared link."

 

This parameter enables you to list the contents of a shared link for a folder, instead of just a folder in the connected user's account which you would identify by path alone.