code
stringlengths 10
343k
| docstring
stringlengths 36
21.9k
| func_name
stringlengths 1
3.35k
| language
stringclasses 1
value | repo
stringlengths 7
58
| path
stringlengths 4
131
| url
stringlengths 44
195
| license
stringclasses 5
values |
|---|---|---|---|---|---|---|---|
routes.sharingListFileMembers = function (arg) {
return this.request('sharing/list_file_members', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Use to obtain the members who have been invited to a file, both inherited and
uninherited members.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListFileMembers
@arg {SharingListFileMembersArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFileMembers>, DropboxResponseError.<SharingListFileMembersError>>} | routes.sharingListFileMembers ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListFileMembersBatch = function (arg) {
return this.request('sharing/list_file_members/batch', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Get members of multiple files at once. The arguments to this route are more
limited, and the limit on query result size per file is more strict. To
customize the results more, use the individual file endpoint. Inherited users
and groups are not included in the result, and permissions are not returned
for this endpoint.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListFileMembersBatch
@arg {SharingListFileMembersBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Array.<SharingListFileMembersBatchResult>>, DropboxResponseError.<SharingSharingUserError>>} | routes.sharingListFileMembersBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListFileMembersContinue = function (arg) {
return this.request('sharing/list_file_members/continue', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Once a cursor has been retrieved from list_file_members or
list_file_members/batch, use this to paginate through all shared file
members.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListFileMembersContinue
@arg {SharingListFileMembersContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFileMembers>, DropboxResponseError.<SharingListFileMembersContinueError>>} | routes.sharingListFileMembersContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListFolderMembers = function (arg) {
return this.request('sharing/list_folder_members', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Returns shared folder membership by its folder ID.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListFolderMembers
@arg {SharingListFolderMembersArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFolderMembers>, DropboxResponseError.<SharingSharedFolderAccessError>>} | routes.sharingListFolderMembers ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListFolderMembersContinue = function (arg) {
return this.request('sharing/list_folder_members/continue', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Once a cursor has been retrieved from list_folder_members, use this to
paginate through all shared folder members.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListFolderMembersContinue
@arg {SharingListFolderMembersContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFolderMembers>, DropboxResponseError.<SharingListFolderMembersContinueError>>} | routes.sharingListFolderMembersContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListFolders = function (arg) {
return this.request('sharing/list_folders', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Return the list of all shared folders the current user has access to.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListFolders
@arg {SharingListFoldersArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingListFoldersResult>, DropboxResponseError.<void>>} | routes.sharingListFolders ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListFoldersContinue = function (arg) {
return this.request('sharing/list_folders/continue', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Once a cursor has been retrieved from list_folders, use this to paginate
through all shared folders. The cursor must come from a previous call to
list_folders or list_folders/continue.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListFoldersContinue
@arg {SharingListFoldersContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingListFoldersResult>, DropboxResponseError.<SharingListFoldersContinueError>>} | routes.sharingListFoldersContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListMountableFolders = function (arg) {
return this.request('sharing/list_mountable_folders', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Return the list of all shared folders the current user can mount or unmount.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListMountableFolders
@arg {SharingListFoldersArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingListFoldersResult>, DropboxResponseError.<void>>} | routes.sharingListMountableFolders ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListMountableFoldersContinue = function (arg) {
return this.request('sharing/list_mountable_folders/continue', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Once a cursor has been retrieved from list_mountable_folders, use this to
paginate through all mountable shared folders. The cursor must come from a
previous call to list_mountable_folders or list_mountable_folders/continue.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListMountableFoldersContinue
@arg {SharingListFoldersContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingListFoldersResult>, DropboxResponseError.<SharingListFoldersContinueError>>} | routes.sharingListMountableFoldersContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListReceivedFiles = function (arg) {
return this.request('sharing/list_received_files', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Returns a list of all files shared with current user. Does not include files
the user has received via shared folders, and does not include unclaimed
invitations.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListReceivedFiles
@arg {SharingListFilesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingListFilesResult>, DropboxResponseError.<SharingSharingUserError>>} | routes.sharingListReceivedFiles ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListReceivedFilesContinue = function (arg) {
return this.request('sharing/list_received_files/continue', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Get more results with a cursor from list_received_files.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListReceivedFilesContinue
@arg {SharingListFilesContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingListFilesResult>, DropboxResponseError.<SharingListFilesContinueError>>} | routes.sharingListReceivedFilesContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingListSharedLinks = function (arg) {
return this.request('sharing/list_shared_links', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | List shared links of this user. If no path is given, returns a list of all
shared links for the current user. For members of business teams using team
space and member folders, returns all shared links in the team member's home
folder unless the team space ID is specified in the request header. For more
information, refer to the Namespace Guide
https://www.dropbox.com/developers/reference/namespace-guide. If a non-empty
path is given, returns a list of all shared links that allow access to the
given path - direct links to the given path and links to parent folders of
the given path. Links to parent folders can be suppressed by setting
direct_only to true.
Route attributes:
scope: sharing.read
@function Dropbox#sharingListSharedLinks
@arg {SharingListSharedLinksArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingListSharedLinksResult>, DropboxResponseError.<SharingListSharedLinksError>>} | routes.sharingListSharedLinks ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingModifySharedLinkSettings = function (arg) {
return this.request('sharing/modify_shared_link_settings', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Modify the shared link's settings. If the requested visibility conflict with
the shared links policy of the team or the shared folder (in case the linked
file is part of a shared folder) then the LinkPermissions.resolved_visibility
of the returned SharedLinkMetadata will reflect the actual visibility of the
shared link and the LinkPermissions.requested_visibility will reflect the
requested visibility.
Route attributes:
scope: sharing.write
@function Dropbox#sharingModifySharedLinkSettings
@arg {SharingModifySharedLinkSettingsArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingModifySharedLinkSettingsError>>} | routes.sharingModifySharedLinkSettings ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingMountFolder = function (arg) {
return this.request('sharing/mount_folder', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | The current user mounts the designated folder. Mount a shared folder for a
user after they have been added as a member. Once mounted, the shared folder
will appear in their Dropbox.
Route attributes:
scope: sharing.write
@function Dropbox#sharingMountFolder
@arg {SharingMountFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFolderMetadata>, DropboxResponseError.<SharingMountFolderError>>} | routes.sharingMountFolder ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingRelinquishFileMembership = function (arg) {
return this.request('sharing/relinquish_file_membership', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | The current user relinquishes their membership in the designated file. Note
that the current user may still have inherited access to this file through
the parent folder.
Route attributes:
scope: sharing.write
@function Dropbox#sharingRelinquishFileMembership
@arg {SharingRelinquishFileMembershipArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<SharingRelinquishFileMembershipError>>} | routes.sharingRelinquishFileMembership ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingRelinquishFolderMembership = function (arg) {
return this.request('sharing/relinquish_folder_membership', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | The current user relinquishes their membership in the designated shared
folder and will no longer have access to the folder. A folder owner cannot
relinquish membership in their own folder. This will run synchronously if
leave_a_copy is false, and asynchronously if leave_a_copy is true.
Route attributes:
scope: sharing.write
@function Dropbox#sharingRelinquishFolderMembership
@arg {SharingRelinquishFolderMembershipArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncLaunchEmptyResult>, DropboxResponseError.<SharingRelinquishFolderMembershipError>>} | routes.sharingRelinquishFolderMembership ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingRemoveFileMember = function (arg) {
return this.request('sharing/remove_file_member', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Identical to remove_file_member_2 but with less information returned.
Route attributes:
scope: sharing.write
@function Dropbox#sharingRemoveFileMember
@deprecated
@arg {SharingRemoveFileMemberArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingFileMemberActionIndividualResult>, DropboxResponseError.<SharingRemoveFileMemberError>>} | routes.sharingRemoveFileMember ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingRemoveFileMember2 = function (arg) {
return this.request('sharing/remove_file_member_2', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Removes a specified member from the file.
Route attributes:
scope: sharing.write
@function Dropbox#sharingRemoveFileMember2
@arg {SharingRemoveFileMemberArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingFileMemberRemoveActionResult>, DropboxResponseError.<SharingRemoveFileMemberError>>} | routes.sharingRemoveFileMember2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingRemoveFolderMember = function (arg) {
return this.request('sharing/remove_folder_member', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Allows an owner or editor (if the ACL update policy allows) of a shared
folder to remove another member.
Route attributes:
scope: sharing.write
@function Dropbox#sharingRemoveFolderMember
@arg {SharingRemoveFolderMemberArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncLaunchResultBase>, DropboxResponseError.<SharingRemoveFolderMemberError>>} | routes.sharingRemoveFolderMember ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingRevokeSharedLink = function (arg) {
return this.request('sharing/revoke_shared_link', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Revoke a shared link. Note that even after revoking a shared link to a file,
the file may be accessible if there are shared links leading to any of the
file parent folders. To list all shared links that enable access to a
specific file, you can use the list_shared_links with the file as the
ListSharedLinksArg.path argument.
Route attributes:
scope: sharing.write
@function Dropbox#sharingRevokeSharedLink
@arg {SharingRevokeSharedLinkArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<SharingRevokeSharedLinkError>>} | routes.sharingRevokeSharedLink ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingSetAccessInheritance = function (arg) {
return this.request('sharing/set_access_inheritance', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Change the inheritance policy of an existing Shared Folder. Only permitted
for shared folders in a shared team root. If a ShareFolderLaunch.async_job_id
is returned, you'll need to call check_share_job_status until the action
completes to get the metadata for the folder.
Route attributes:
scope: sharing.write
@function Dropbox#sharingSetAccessInheritance
@arg {SharingSetAccessInheritanceArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingShareFolderLaunch>, DropboxResponseError.<SharingSetAccessInheritanceError>>} | routes.sharingSetAccessInheritance ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingShareFolder = function (arg) {
return this.request('sharing/share_folder', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Share a folder with collaborators. Most sharing will be completed
synchronously. Large folders will be completed asynchronously. To make
testing the async case repeatable, set `ShareFolderArg.force_async`. If a
ShareFolderLaunch.async_job_id is returned, you'll need to call
check_share_job_status until the action completes to get the metadata for the
folder.
Route attributes:
scope: sharing.write
@function Dropbox#sharingShareFolder
@arg {SharingShareFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingShareFolderLaunch>, DropboxResponseError.<SharingShareFolderError>>} | routes.sharingShareFolder ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingTransferFolder = function (arg) {
return this.request('sharing/transfer_folder', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Transfer ownership of a shared folder to a member of the shared folder. User
must have AccessLevel.owner access to the shared folder to perform a
transfer.
Route attributes:
scope: sharing.write
@function Dropbox#sharingTransferFolder
@arg {SharingTransferFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<SharingTransferFolderError>>} | routes.sharingTransferFolder ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingUnmountFolder = function (arg) {
return this.request('sharing/unmount_folder', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | The current user unmounts the designated folder. They can re-mount the folder
at a later time using mount_folder.
Route attributes:
scope: sharing.write
@function Dropbox#sharingUnmountFolder
@arg {SharingUnmountFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<SharingUnmountFolderError>>} | routes.sharingUnmountFolder ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingUnshareFile = function (arg) {
return this.request('sharing/unshare_file', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Remove all members from this file. Does not remove inherited members.
Route attributes:
scope: sharing.write
@function Dropbox#sharingUnshareFile
@arg {SharingUnshareFileArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<SharingUnshareFileError>>} | routes.sharingUnshareFile ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingUnshareFolder = function (arg) {
return this.request('sharing/unshare_folder', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Allows a shared folder owner to unshare the folder. You'll need to call
check_job_status to determine if the action has completed successfully.
Route attributes:
scope: sharing.write
@function Dropbox#sharingUnshareFolder
@arg {SharingUnshareFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncLaunchEmptyResult>, DropboxResponseError.<SharingUnshareFolderError>>} | routes.sharingUnshareFolder ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingUpdateFileMember = function (arg) {
return this.request('sharing/update_file_member', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Changes a member's access on a shared file.
Route attributes:
scope: sharing.write
@function Dropbox#sharingUpdateFileMember
@arg {SharingUpdateFileMemberArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingMemberAccessLevelResult>, DropboxResponseError.<SharingFileMemberActionError>>} | routes.sharingUpdateFileMember ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingUpdateFolderMember = function (arg) {
return this.request('sharing/update_folder_member', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Allows an owner or editor of a shared folder to update another member's
permissions.
Route attributes:
scope: sharing.write
@function Dropbox#sharingUpdateFolderMember
@arg {SharingUpdateFolderMemberArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingMemberAccessLevelResult>, DropboxResponseError.<SharingUpdateFolderMemberError>>} | routes.sharingUpdateFolderMember ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingUpdateFolderPolicy = function (arg) {
return this.request('sharing/update_folder_policy', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Update the sharing policies for a shared folder. User must have
AccessLevel.owner access to the shared folder to update its policies.
Route attributes:
scope: sharing.write
@function Dropbox#sharingUpdateFolderPolicy
@arg {SharingUpdateFolderPolicyArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFolderMetadata>, DropboxResponseError.<SharingUpdateFolderPolicyError>>} | routes.sharingUpdateFolderPolicy ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamDevicesListMemberDevices = function (arg) {
return this.request('team/devices/list_member_devices', arg, 'team', 'api', 'rpc', 'sessions.list');
}; | List all device sessions of a team's member.
Route attributes:
scope: sessions.list
@function Dropbox#teamDevicesListMemberDevices
@arg {TeamListMemberDevicesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamListMemberDevicesResult>, DropboxResponseError.<TeamListMemberDevicesError>>} | routes.teamDevicesListMemberDevices ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamDevicesListMembersDevices = function (arg) {
return this.request('team/devices/list_members_devices', arg, 'team', 'api', 'rpc', 'sessions.list');
}; | List all device sessions of a team. Permission : Team member file access.
Route attributes:
scope: sessions.list
@function Dropbox#teamDevicesListMembersDevices
@arg {TeamListMembersDevicesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamListMembersDevicesResult>, DropboxResponseError.<TeamListMembersDevicesError>>} | routes.teamDevicesListMembersDevices ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamDevicesListTeamDevices = function (arg) {
return this.request('team/devices/list_team_devices', arg, 'team', 'api', 'rpc', 'sessions.list');
}; | List all device sessions of a team. Permission : Team member file access.
Route attributes:
scope: sessions.list
@function Dropbox#teamDevicesListTeamDevices
@deprecated
@arg {TeamListTeamDevicesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamListTeamDevicesResult>, DropboxResponseError.<TeamListTeamDevicesError>>} | routes.teamDevicesListTeamDevices ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamDevicesRevokeDeviceSession = function (arg) {
return this.request('team/devices/revoke_device_session', arg, 'team', 'api', 'rpc', 'sessions.modify');
}; | Revoke a device session of a team's member.
Route attributes:
scope: sessions.modify
@function Dropbox#teamDevicesRevokeDeviceSession
@arg {TeamRevokeDeviceSessionArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamRevokeDeviceSessionError>>} | routes.teamDevicesRevokeDeviceSession ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamDevicesRevokeDeviceSessionBatch = function (arg) {
return this.request('team/devices/revoke_device_session_batch', arg, 'team', 'api', 'rpc', 'sessions.modify');
}; | Revoke a list of device sessions of team members.
Route attributes:
scope: sessions.modify
@function Dropbox#teamDevicesRevokeDeviceSessionBatch
@arg {TeamRevokeDeviceSessionBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamRevokeDeviceSessionBatchResult>, DropboxResponseError.<TeamRevokeDeviceSessionBatchError>>} | routes.teamDevicesRevokeDeviceSessionBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamFeaturesGetValues = function (arg) {
return this.request('team/features/get_values', arg, 'team', 'api', 'rpc', 'team_info.read');
}; | Get the values for one or more featues. This route allows you to check your
account's capability for what feature you can access or what value you have
for certain features. Permission : Team information.
Route attributes:
scope: team_info.read
@function Dropbox#teamFeaturesGetValues
@arg {TeamFeaturesGetValuesBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamFeaturesGetValuesBatchResult>, DropboxResponseError.<TeamFeaturesGetValuesBatchError>>} | routes.teamFeaturesGetValues ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGetInfo = function () {
return this.request('team/get_info', null, 'team', 'api', 'rpc', 'team_info.read');
}; | Retrieves information about a team.
Route attributes:
scope: team_info.read
@function Dropbox#teamGetInfo
@returns {Promise.<DropboxResponse<TeamTeamGetInfoResult>, DropboxResponseError.<void>>} | routes.teamGetInfo ( ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsCreate = function (arg) {
return this.request('team/groups/create', arg, 'team', 'api', 'rpc', 'groups.write');
}; | Creates a new, empty group, with a requested name. Permission : Team member
management.
Route attributes:
scope: groups.write
@function Dropbox#teamGroupsCreate
@arg {TeamGroupCreateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupFullInfo>, DropboxResponseError.<TeamGroupCreateError>>} | routes.teamGroupsCreate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsDelete = function (arg) {
return this.request('team/groups/delete', arg, 'team', 'api', 'rpc', 'groups.write');
}; | Deletes a group. The group is deleted immediately. However the revoking of
group-owned resources may take additional time. Use the groups/job_status/get
to determine whether this process has completed. Permission : Team member
management.
Route attributes:
scope: groups.write
@function Dropbox#teamGroupsDelete
@arg {TeamGroupSelector} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncLaunchEmptyResult>, DropboxResponseError.<TeamGroupDeleteError>>} | routes.teamGroupsDelete ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsGetInfo = function (arg) {
return this.request('team/groups/get_info', arg, 'team', 'api', 'rpc', 'groups.read');
}; | Retrieves information about one or more groups. Note that the optional field
GroupFullInfo.members is not returned for system-managed groups. Permission :
Team Information.
Route attributes:
scope: groups.read
@function Dropbox#teamGroupsGetInfo
@arg {TeamGroupsSelector} arg - The request parameters.
@returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamGroupsGetInfoError>>} | routes.teamGroupsGetInfo ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsJobStatusGet = function (arg) {
return this.request('team/groups/job_status/get', arg, 'team', 'api', 'rpc', 'groups.write');
}; | Once an async_job_id is returned from groups/delete, groups/members/add , or
groups/members/remove use this method to poll the status of granting/revoking
group members' access to group-owned resources. Permission : Team member
management.
Route attributes:
scope: groups.write
@function Dropbox#teamGroupsJobStatusGet
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncPollEmptyResult>, DropboxResponseError.<TeamGroupsPollError>>} | routes.teamGroupsJobStatusGet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsList = function (arg) {
return this.request('team/groups/list', arg, 'team', 'api', 'rpc', 'groups.read');
}; | Lists groups on a team. Permission : Team Information.
Route attributes:
scope: groups.read
@function Dropbox#teamGroupsList
@arg {TeamGroupsListArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupsListResult>, DropboxResponseError.<void>>} | routes.teamGroupsList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsListContinue = function (arg) {
return this.request('team/groups/list/continue', arg, 'team', 'api', 'rpc', 'groups.read');
}; | Once a cursor has been retrieved from groups/list, use this to paginate
through all groups. Permission : Team Information.
Route attributes:
scope: groups.read
@function Dropbox#teamGroupsListContinue
@arg {TeamGroupsListContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupsListResult>, DropboxResponseError.<TeamGroupsListContinueError>>} | routes.teamGroupsListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsMembersAdd = function (arg) {
return this.request('team/groups/members/add', arg, 'team', 'api', 'rpc', 'groups.write');
}; | Adds members to a group. The members are added immediately. However the
granting of group-owned resources may take additional time. Use the
groups/job_status/get to determine whether this process has completed.
Permission : Team member management.
Route attributes:
scope: groups.write
@function Dropbox#teamGroupsMembersAdd
@arg {TeamGroupMembersAddArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupMembersChangeResult>, DropboxResponseError.<TeamGroupMembersAddError>>} | routes.teamGroupsMembersAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsMembersList = function (arg) {
return this.request('team/groups/members/list', arg, 'team', 'api', 'rpc', 'groups.read');
}; | Lists members of a group. Permission : Team Information.
Route attributes:
scope: groups.read
@function Dropbox#teamGroupsMembersList
@arg {TeamGroupsMembersListArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupsMembersListResult>, DropboxResponseError.<TeamGroupSelectorError>>} | routes.teamGroupsMembersList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsMembersListContinue = function (arg) {
return this.request('team/groups/members/list/continue', arg, 'team', 'api', 'rpc', 'groups.read');
}; | Once a cursor has been retrieved from groups/members/list, use this to
paginate through all members of the group. Permission : Team information.
Route attributes:
scope: groups.read
@function Dropbox#teamGroupsMembersListContinue
@arg {TeamGroupsMembersListContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupsMembersListResult>, DropboxResponseError.<TeamGroupsMembersListContinueError>>} | routes.teamGroupsMembersListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsMembersRemove = function (arg) {
return this.request('team/groups/members/remove', arg, 'team', 'api', 'rpc', 'groups.write');
}; | Removes members from a group. The members are removed immediately. However
the revoking of group-owned resources may take additional time. Use the
groups/job_status/get to determine whether this process has completed. This
method permits removing the only owner of a group, even in cases where this
is not possible via the web client. Permission : Team member management.
Route attributes:
scope: groups.write
@function Dropbox#teamGroupsMembersRemove
@arg {TeamGroupMembersRemoveArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupMembersChangeResult>, DropboxResponseError.<TeamGroupMembersRemoveError>>} | routes.teamGroupsMembersRemove ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsMembersSetAccessType = function (arg) {
return this.request('team/groups/members/set_access_type', arg, 'team', 'api', 'rpc', 'groups.write');
}; | Sets a member's access type in a group. Permission : Team member management.
Route attributes:
scope: groups.write
@function Dropbox#teamGroupsMembersSetAccessType
@arg {TeamGroupMembersSetAccessTypeArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamGroupMemberSetAccessTypeError>>} | routes.teamGroupsMembersSetAccessType ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamGroupsUpdate = function (arg) {
return this.request('team/groups/update', arg, 'team', 'api', 'rpc', 'groups.write');
}; | Updates a group's name and/or external ID. Permission : Team member
management.
Route attributes:
scope: groups.write
@function Dropbox#teamGroupsUpdate
@arg {TeamGroupUpdateArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamGroupFullInfo>, DropboxResponseError.<TeamGroupUpdateError>>} | routes.teamGroupsUpdate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLegalHoldsCreatePolicy = function (arg) {
return this.request('team/legal_holds/create_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
}; | Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all
teams have the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
@function Dropbox#teamLegalHoldsCreatePolicy
@arg {TeamLegalHoldsPolicyCreateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamLegalHoldsPolicyCreateError>>} | routes.teamLegalHoldsCreatePolicy ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLegalHoldsGetPolicy = function (arg) {
return this.request('team/legal_holds/get_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
}; | Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams
have the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
@function Dropbox#teamLegalHoldsGetPolicy
@arg {TeamLegalHoldsGetPolicyArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamLegalHoldsGetPolicyError>>} | routes.teamLegalHoldsGetPolicy ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLegalHoldsListHeldRevisions = function (arg) {
return this.request('team/legal_holds/list_held_revisions', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
}; | List the file metadata that's under the hold. Note: Legal Holds is a paid
add-on. Not all teams have the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
@function Dropbox#teamLegalHoldsListHeldRevisions
@arg {TeamLegalHoldsListHeldRevisionsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamLegalHoldsListHeldRevisionResult>, DropboxResponseError.<TeamLegalHoldsListHeldRevisionsError>>} | routes.teamLegalHoldsListHeldRevisions ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLegalHoldsListHeldRevisionsContinue = function (arg) {
return this.request('team/legal_holds/list_held_revisions_continue', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
}; | Continue listing the file metadata that's under the hold. Note: Legal Holds
is a paid add-on. Not all teams have the feature. Permission : Team member
file access.
Route attributes:
scope: team_data.governance.write
@function Dropbox#teamLegalHoldsListHeldRevisionsContinue
@arg {TeamLegalHoldsListHeldRevisionsContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamLegalHoldsListHeldRevisionResult>, DropboxResponseError.<TeamLegalHoldsListHeldRevisionsError>>} | routes.teamLegalHoldsListHeldRevisionsContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLegalHoldsListPolicies = function (arg) {
return this.request('team/legal_holds/list_policies', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
}; | Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all
teams have the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
@function Dropbox#teamLegalHoldsListPolicies
@arg {TeamLegalHoldsListPoliciesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamLegalHoldsListPoliciesResult>, DropboxResponseError.<TeamLegalHoldsListPoliciesError>>} | routes.teamLegalHoldsListPolicies ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLegalHoldsReleasePolicy = function (arg) {
return this.request('team/legal_holds/release_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
}; | Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all
teams have the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
@function Dropbox#teamLegalHoldsReleasePolicy
@arg {TeamLegalHoldsPolicyReleaseArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamLegalHoldsPolicyReleaseError>>} | routes.teamLegalHoldsReleasePolicy ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLegalHoldsUpdatePolicy = function (arg) {
return this.request('team/legal_holds/update_policy', arg, 'team', 'api', 'rpc', 'team_data.governance.write');
}; | Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have
the feature. Permission : Team member file access.
Route attributes:
scope: team_data.governance.write
@function Dropbox#teamLegalHoldsUpdatePolicy
@arg {TeamLegalHoldsPolicyUpdateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamLegalHoldsPolicyUpdateError>>} | routes.teamLegalHoldsUpdatePolicy ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLinkedAppsListMemberLinkedApps = function (arg) {
return this.request('team/linked_apps/list_member_linked_apps', arg, 'team', 'api', 'rpc', 'sessions.list');
}; | List all linked applications of the team member. Note, this endpoint does not
list any team-linked applications.
Route attributes:
scope: sessions.list
@function Dropbox#teamLinkedAppsListMemberLinkedApps
@arg {TeamListMemberAppsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamListMemberAppsResult>, DropboxResponseError.<TeamListMemberAppsError>>} | routes.teamLinkedAppsListMemberLinkedApps ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLinkedAppsListMembersLinkedApps = function (arg) {
return this.request('team/linked_apps/list_members_linked_apps', arg, 'team', 'api', 'rpc', 'sessions.list');
}; | List all applications linked to the team members' accounts. Note, this
endpoint does not list any team-linked applications.
Route attributes:
scope: sessions.list
@function Dropbox#teamLinkedAppsListMembersLinkedApps
@arg {TeamListMembersAppsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamListMembersAppsResult>, DropboxResponseError.<TeamListMembersAppsError>>} | routes.teamLinkedAppsListMembersLinkedApps ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLinkedAppsListTeamLinkedApps = function (arg) {
return this.request('team/linked_apps/list_team_linked_apps', arg, 'team', 'api', 'rpc', 'sessions.list');
}; | List all applications linked to the team members' accounts. Note, this
endpoint doesn't list any team-linked applications.
Route attributes:
scope: sessions.list
@function Dropbox#teamLinkedAppsListTeamLinkedApps
@deprecated
@arg {TeamListTeamAppsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamListTeamAppsResult>, DropboxResponseError.<TeamListTeamAppsError>>} | routes.teamLinkedAppsListTeamLinkedApps ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLinkedAppsRevokeLinkedApp = function (arg) {
return this.request('team/linked_apps/revoke_linked_app', arg, 'team', 'api', 'rpc', 'sessions.modify');
}; | Revoke a linked application of the team member.
Route attributes:
scope: sessions.modify
@function Dropbox#teamLinkedAppsRevokeLinkedApp
@arg {TeamRevokeLinkedApiAppArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamRevokeLinkedAppError>>} | routes.teamLinkedAppsRevokeLinkedApp ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamLinkedAppsRevokeLinkedAppBatch = function (arg) {
return this.request('team/linked_apps/revoke_linked_app_batch', arg, 'team', 'api', 'rpc', 'sessions.modify');
}; | Revoke a list of linked applications of the team members.
Route attributes:
scope: sessions.modify
@function Dropbox#teamLinkedAppsRevokeLinkedAppBatch
@arg {TeamRevokeLinkedApiAppBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamRevokeLinkedAppBatchResult>, DropboxResponseError.<TeamRevokeLinkedAppBatchError>>} | routes.teamLinkedAppsRevokeLinkedAppBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMemberSpaceLimitsExcludedUsersAdd = function (arg) {
return this.request('team/member_space_limits/excluded_users/add', arg, 'team', 'api', 'rpc', 'members.write');
}; | Add users to member space limits excluded users list.
Route attributes:
scope: members.write
@function Dropbox#teamMemberSpaceLimitsExcludedUsersAdd
@arg {TeamExcludedUsersUpdateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamExcludedUsersUpdateResult>, DropboxResponseError.<TeamExcludedUsersUpdateError>>} | routes.teamMemberSpaceLimitsExcludedUsersAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMemberSpaceLimitsExcludedUsersList = function (arg) {
return this.request('team/member_space_limits/excluded_users/list', arg, 'team', 'api', 'rpc', 'members.read');
}; | List member space limits excluded users.
Route attributes:
scope: members.read
@function Dropbox#teamMemberSpaceLimitsExcludedUsersList
@arg {TeamExcludedUsersListArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamExcludedUsersListResult>, DropboxResponseError.<TeamExcludedUsersListError>>} | routes.teamMemberSpaceLimitsExcludedUsersList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMemberSpaceLimitsExcludedUsersListContinue = function (arg) {
return this.request('team/member_space_limits/excluded_users/list/continue', arg, 'team', 'api', 'rpc', 'members.read');
}; | Continue listing member space limits excluded users.
Route attributes:
scope: members.read
@function Dropbox#teamMemberSpaceLimitsExcludedUsersListContinue
@arg {TeamExcludedUsersListContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamExcludedUsersListResult>, DropboxResponseError.<TeamExcludedUsersListContinueError>>} | routes.teamMemberSpaceLimitsExcludedUsersListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMemberSpaceLimitsExcludedUsersRemove = function (arg) {
return this.request('team/member_space_limits/excluded_users/remove', arg, 'team', 'api', 'rpc', 'members.write');
}; | Remove users from member space limits excluded users list.
Route attributes:
scope: members.write
@function Dropbox#teamMemberSpaceLimitsExcludedUsersRemove
@arg {TeamExcludedUsersUpdateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamExcludedUsersUpdateResult>, DropboxResponseError.<TeamExcludedUsersUpdateError>>} | routes.teamMemberSpaceLimitsExcludedUsersRemove ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMemberSpaceLimitsGetCustomQuota = function (arg) {
return this.request('team/member_space_limits/get_custom_quota', arg, 'team', 'api', 'rpc', 'members.read');
}; | Get users custom quota. Returns none as the custom quota if none was set. A
maximum of 1000 members can be specified in a single call.
Route attributes:
scope: members.read
@function Dropbox#teamMemberSpaceLimitsGetCustomQuota
@arg {TeamCustomQuotaUsersArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Array.<TeamCustomQuotaResult>>, DropboxResponseError.<TeamCustomQuotaError>>} | routes.teamMemberSpaceLimitsGetCustomQuota ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMemberSpaceLimitsRemoveCustomQuota = function (arg) {
return this.request('team/member_space_limits/remove_custom_quota', arg, 'team', 'api', 'rpc', 'members.write');
}; | Remove users custom quota. A maximum of 1000 members can be specified in a
single call.
Route attributes:
scope: members.write
@function Dropbox#teamMemberSpaceLimitsRemoveCustomQuota
@arg {TeamCustomQuotaUsersArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Array.<TeamRemoveCustomQuotaResult>>, DropboxResponseError.<TeamCustomQuotaError>>} | routes.teamMemberSpaceLimitsRemoveCustomQuota ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMemberSpaceLimitsSetCustomQuota = function (arg) {
return this.request('team/member_space_limits/set_custom_quota', arg, 'team', 'api', 'rpc', 'members.read');
}; | Set users custom quota. Custom quota has to be at least 15GB. A maximum of
1000 members can be specified in a single call.
Route attributes:
scope: members.read
@function Dropbox#teamMemberSpaceLimitsSetCustomQuota
@arg {TeamSetCustomQuotaArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Array.<TeamCustomQuotaResult>>, DropboxResponseError.<TeamSetCustomQuotaError>>} | routes.teamMemberSpaceLimitsSetCustomQuota ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersAddV2 = function (arg) {
return this.request('team/members/add_v2', arg, 'team', 'api', 'rpc', 'members.write');
}; | Adds members to a team. Permission : Team member management A maximum of 20
members can be specified in a single call. If no Dropbox account exists with
the email address specified, a new Dropbox account will be created with the
given email address, and that account will be invited to the team. If a
personal Dropbox account exists with the email address specified in the call,
this call will create a placeholder Dropbox account for the user on the team
and send an email inviting the user to migrate their existing personal
account onto the team. Team member management apps are required to set an
initial given_name and surname for a user to use in the team invitation and
for 'Perform as team member' actions taken on the user before they become
'active'.
Route attributes:
scope: members.write
@function Dropbox#teamMembersAddV2
@arg {TeamMembersAddV2Arg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersAddLaunchV2Result>, DropboxResponseError.<void>>} | routes.teamMembersAddV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersAdd = function (arg) {
return this.request('team/members/add', arg, 'team', 'api', 'rpc', 'members.write');
}; | Adds members to a team. Permission : Team member management A maximum of 20
members can be specified in a single call. If no Dropbox account exists with
the email address specified, a new Dropbox account will be created with the
given email address, and that account will be invited to the team. If a
personal Dropbox account exists with the email address specified in the call,
this call will create a placeholder Dropbox account for the user on the team
and send an email inviting the user to migrate their existing personal
account onto the team. Team member management apps are required to set an
initial given_name and surname for a user to use in the team invitation and
for 'Perform as team member' actions taken on the user before they become
'active'.
Route attributes:
scope: members.write
@function Dropbox#teamMembersAdd
@arg {TeamMembersAddArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersAddLaunch>, DropboxResponseError.<void>>} | routes.teamMembersAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersAddJobStatusGetV2 = function (arg) {
return this.request('team/members/add/job_status/get_v2', arg, 'team', 'api', 'rpc', 'members.write');
}; | Once an async_job_id is returned from members/add_v2 , use this to poll the
status of the asynchronous request. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersAddJobStatusGetV2
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersAddJobStatusV2Result>, DropboxResponseError.<AsyncPollError>>} | routes.teamMembersAddJobStatusGetV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersAddJobStatusGet = function (arg) {
return this.request('team/members/add/job_status/get', arg, 'team', 'api', 'rpc', 'members.write');
}; | Once an async_job_id is returned from members/add , use this to poll the
status of the asynchronous request. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersAddJobStatusGet
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersAddJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.teamMembersAddJobStatusGet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersDeleteProfilePhotoV2 = function (arg) {
return this.request('team/members/delete_profile_photo_v2', arg, 'team', 'api', 'rpc', 'members.write');
}; | Deletes a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersDeleteProfilePhotoV2
@arg {TeamMembersDeleteProfilePhotoArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamMemberInfoV2Result>, DropboxResponseError.<TeamMembersDeleteProfilePhotoError>>} | routes.teamMembersDeleteProfilePhotoV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersDeleteProfilePhoto = function (arg) {
return this.request('team/members/delete_profile_photo', arg, 'team', 'api', 'rpc', 'members.write');
}; | Deletes a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersDeleteProfilePhoto
@arg {TeamMembersDeleteProfilePhotoArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamMemberInfo>, DropboxResponseError.<TeamMembersDeleteProfilePhotoError>>} | routes.teamMembersDeleteProfilePhoto ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersGetAvailableTeamMemberRoles = function () {
return this.request('team/members/get_available_team_member_roles', null, 'team', 'api', 'rpc', 'members.read');
}; | Get available TeamMemberRoles for the connected team. To be used with
members/set_admin_permissions_v2. Permission : Team member management.
Route attributes:
scope: members.read
@function Dropbox#teamMembersGetAvailableTeamMemberRoles
@returns {Promise.<DropboxResponse<TeamMembersGetAvailableTeamMemberRolesResult>, DropboxResponseError.<void>>} | routes.teamMembersGetAvailableTeamMemberRoles ( ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersGetInfoV2 = function (arg) {
return this.request('team/members/get_info_v2', arg, 'team', 'api', 'rpc', 'members.read');
}; | Returns information about multiple team members. Permission : Team
information This endpoint will return MembersGetInfoItem.id_not_found, for
IDs (or emails) that cannot be matched to a valid team member.
Route attributes:
scope: members.read
@function Dropbox#teamMembersGetInfoV2
@arg {TeamMembersGetInfoV2Arg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersGetInfoV2Result>, DropboxResponseError.<TeamMembersGetInfoError>>} | routes.teamMembersGetInfoV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersGetInfo = function (arg) {
return this.request('team/members/get_info', arg, 'team', 'api', 'rpc', 'members.read');
}; | Returns information about multiple team members. Permission : Team
information This endpoint will return MembersGetInfoItem.id_not_found, for
IDs (or emails) that cannot be matched to a valid team member.
Route attributes:
scope: members.read
@function Dropbox#teamMembersGetInfo
@arg {TeamMembersGetInfoArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<Object>, DropboxResponseError.<TeamMembersGetInfoError>>} | routes.teamMembersGetInfo ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersListV2 = function (arg) {
return this.request('team/members/list_v2', arg, 'team', 'api', 'rpc', 'members.read');
}; | Lists members of a team. Permission : Team information.
Route attributes:
scope: members.read
@function Dropbox#teamMembersListV2
@arg {TeamMembersListArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersListV2Result>, DropboxResponseError.<TeamMembersListError>>} | routes.teamMembersListV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersList = function (arg) {
return this.request('team/members/list', arg, 'team', 'api', 'rpc', 'members.read');
}; | Lists members of a team. Permission : Team information.
Route attributes:
scope: members.read
@function Dropbox#teamMembersList
@arg {TeamMembersListArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersListResult>, DropboxResponseError.<TeamMembersListError>>} | routes.teamMembersList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersListContinueV2 = function (arg) {
return this.request('team/members/list/continue_v2', arg, 'team', 'api', 'rpc', 'members.read');
}; | Once a cursor has been retrieved from members/list_v2, use this to paginate
through all team members. Permission : Team information.
Route attributes:
scope: members.read
@function Dropbox#teamMembersListContinueV2
@arg {TeamMembersListContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersListV2Result>, DropboxResponseError.<TeamMembersListContinueError>>} | routes.teamMembersListContinueV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersListContinue = function (arg) {
return this.request('team/members/list/continue', arg, 'team', 'api', 'rpc', 'members.read');
}; | Once a cursor has been retrieved from members/list, use this to paginate
through all team members. Permission : Team information.
Route attributes:
scope: members.read
@function Dropbox#teamMembersListContinue
@arg {TeamMembersListContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersListResult>, DropboxResponseError.<TeamMembersListContinueError>>} | routes.teamMembersListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersMoveFormerMemberFiles = function (arg) {
return this.request('team/members/move_former_member_files', arg, 'team', 'api', 'rpc', 'members.write');
}; | Moves removed member's files to a different member. This endpoint initiates
an asynchronous job. To obtain the final result of the job, the client should
periodically poll members/move_former_member_files/job_status/check.
Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersMoveFormerMemberFiles
@arg {TeamMembersDataTransferArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncLaunchEmptyResult>, DropboxResponseError.<TeamMembersTransferFormerMembersFilesError>>} | routes.teamMembersMoveFormerMemberFiles ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersMoveFormerMemberFilesJobStatusCheck = function (arg) {
return this.request('team/members/move_former_member_files/job_status/check', arg, 'team', 'api', 'rpc', 'members.write');
}; | Once an async_job_id is returned from members/move_former_member_files , use
this to poll the status of the asynchronous request. Permission : Team member
management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersMoveFormerMemberFilesJobStatusCheck
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncPollEmptyResult>, DropboxResponseError.<AsyncPollError>>} | routes.teamMembersMoveFormerMemberFilesJobStatusCheck ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersRecover = function (arg) {
return this.request('team/members/recover', arg, 'team', 'api', 'rpc', 'members.delete');
}; | Recover a deleted member. Permission : Team member management Exactly one of
team_member_id, email, or external_id must be provided to identify the user
account.
Route attributes:
scope: members.delete
@function Dropbox#teamMembersRecover
@arg {TeamMembersRecoverArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamMembersRecoverError>>} | routes.teamMembersRecover ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersRemove = function (arg) {
return this.request('team/members/remove', arg, 'team', 'api', 'rpc', 'members.delete');
}; | Removes a member from a team. Permission : Team member management Exactly one
of team_member_id, email, or external_id must be provided to identify the
user account. Accounts can be recovered via members/recover for a 7 day
period or until the account has been permanently deleted or transferred to
another account (whichever comes first). Calling members/add while a user is
still recoverable on your team will return with
MemberAddResult.user_already_on_team. Accounts can have their files
transferred via the admin console for a limited time, based on the version
history length associated with the team (180 days for most teams). This
endpoint may initiate an asynchronous job. To obtain the final result of the
job, the client should periodically poll members/remove/job_status/get.
Route attributes:
scope: members.delete
@function Dropbox#teamMembersRemove
@arg {TeamMembersRemoveArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncLaunchEmptyResult>, DropboxResponseError.<TeamMembersRemoveError>>} | routes.teamMembersRemove ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersRemoveJobStatusGet = function (arg) {
return this.request('team/members/remove/job_status/get', arg, 'team', 'api', 'rpc', 'members.delete');
}; | Once an async_job_id is returned from members/remove , use this to poll the
status of the asynchronous request. Permission : Team member management.
Route attributes:
scope: members.delete
@function Dropbox#teamMembersRemoveJobStatusGet
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<AsyncPollEmptyResult>, DropboxResponseError.<AsyncPollError>>} | routes.teamMembersRemoveJobStatusGet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSecondaryEmailsAdd = function (arg) {
return this.request('team/members/secondary_emails/add', arg, 'team', 'api', 'rpc', 'members.write');
}; | Add secondary emails to users. Permission : Team member management. Emails
that are on verified domains will be verified automatically. For each email
address not on a verified domain a verification email will be sent.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSecondaryEmailsAdd
@arg {TeamAddSecondaryEmailsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamAddSecondaryEmailsResult>, DropboxResponseError.<TeamAddSecondaryEmailsError>>} | routes.teamMembersSecondaryEmailsAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSecondaryEmailsDelete = function (arg) {
return this.request('team/members/secondary_emails/delete', arg, 'team', 'api', 'rpc', 'members.write');
}; | Delete secondary emails from users Permission : Team member management. Users
will be notified of deletions of verified secondary emails at both the
secondary email and their primary email.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSecondaryEmailsDelete
@arg {TeamDeleteSecondaryEmailsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamDeleteSecondaryEmailsResult>, DropboxResponseError.<void>>} | routes.teamMembersSecondaryEmailsDelete ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSecondaryEmailsResendVerificationEmails = function (arg) {
return this.request('team/members/secondary_emails/resend_verification_emails', arg, 'team', 'api', 'rpc', 'members.write');
}; | Resend secondary email verification emails. Permission : Team member
management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSecondaryEmailsResendVerificationEmails
@arg {TeamResendVerificationEmailArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamResendVerificationEmailResult>, DropboxResponseError.<void>>} | routes.teamMembersSecondaryEmailsResendVerificationEmails ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSendWelcomeEmail = function (arg) {
return this.request('team/members/send_welcome_email', arg, 'team', 'api', 'rpc', 'members.write');
}; | Sends welcome email to pending team member. Permission : Team member
management Exactly one of team_member_id, email, or external_id must be
provided to identify the user account. No-op if team member is not pending.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSendWelcomeEmail
@arg {TeamUserSelectorArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamMembersSendWelcomeError>>} | routes.teamMembersSendWelcomeEmail ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSetAdminPermissionsV2 = function (arg) {
return this.request('team/members/set_admin_permissions_v2', arg, 'team', 'api', 'rpc', 'members.write');
}; | Updates a team member's permissions. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSetAdminPermissionsV2
@arg {TeamMembersSetPermissions2Arg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersSetPermissions2Result>, DropboxResponseError.<TeamMembersSetPermissions2Error>>} | routes.teamMembersSetAdminPermissionsV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSetAdminPermissions = function (arg) {
return this.request('team/members/set_admin_permissions', arg, 'team', 'api', 'rpc', 'members.write');
}; | Updates a team member's permissions. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSetAdminPermissions
@arg {TeamMembersSetPermissionsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamMembersSetPermissionsResult>, DropboxResponseError.<TeamMembersSetPermissionsError>>} | routes.teamMembersSetAdminPermissions ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSetProfileV2 = function (arg) {
return this.request('team/members/set_profile_v2', arg, 'team', 'api', 'rpc', 'members.write');
}; | Updates a team member's profile. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSetProfileV2
@arg {TeamMembersSetProfileArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamMemberInfoV2Result>, DropboxResponseError.<TeamMembersSetProfileError>>} | routes.teamMembersSetProfileV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSetProfile = function (arg) {
return this.request('team/members/set_profile', arg, 'team', 'api', 'rpc', 'members.write');
}; | Updates a team member's profile. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSetProfile
@arg {TeamMembersSetProfileArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamMemberInfo>, DropboxResponseError.<TeamMembersSetProfileError>>} | routes.teamMembersSetProfile ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSetProfilePhotoV2 = function (arg) {
return this.request('team/members/set_profile_photo_v2', arg, 'team', 'api', 'rpc', 'members.write');
}; | Updates a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSetProfilePhotoV2
@arg {TeamMembersSetProfilePhotoArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamMemberInfoV2Result>, DropboxResponseError.<TeamMembersSetProfilePhotoError>>} | routes.teamMembersSetProfilePhotoV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSetProfilePhoto = function (arg) {
return this.request('team/members/set_profile_photo', arg, 'team', 'api', 'rpc', 'members.write');
}; | Updates a team member's profile photo. Permission : Team member management.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSetProfilePhoto
@arg {TeamMembersSetProfilePhotoArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamMemberInfo>, DropboxResponseError.<TeamMembersSetProfilePhotoError>>} | routes.teamMembersSetProfilePhoto ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersSuspend = function (arg) {
return this.request('team/members/suspend', arg, 'team', 'api', 'rpc', 'members.write');
}; | Suspend a member from a team. Permission : Team member management Exactly one
of team_member_id, email, or external_id must be provided to identify the
user account.
Route attributes:
scope: members.write
@function Dropbox#teamMembersSuspend
@arg {TeamMembersDeactivateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamMembersSuspendError>>} | routes.teamMembersSuspend ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamMembersUnsuspend = function (arg) {
return this.request('team/members/unsuspend', arg, 'team', 'api', 'rpc', 'members.write');
}; | Unsuspend a member from a team. Permission : Team member management Exactly
one of team_member_id, email, or external_id must be provided to identify the
user account.
Route attributes:
scope: members.write
@function Dropbox#teamMembersUnsuspend
@arg {TeamMembersUnsuspendArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<TeamMembersUnsuspendError>>} | routes.teamMembersUnsuspend ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamNamespacesList = function (arg) {
return this.request('team/namespaces/list', arg, 'team', 'api', 'rpc', 'team_data.member');
}; | Returns a list of all team-accessible namespaces. This list includes team
folders, shared folders containing team members, team members' home
namespaces, and team members' app folders. Home namespaces and app folders
are always owned by this team or members of the team, but shared folders may
be owned by other users or other teams. Duplicates may occur in the list.
Route attributes:
scope: team_data.member
@function Dropbox#teamNamespacesList
@arg {TeamTeamNamespacesListArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamNamespacesListResult>, DropboxResponseError.<TeamTeamNamespacesListError>>} | routes.teamNamespacesList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamNamespacesListContinue = function (arg) {
return this.request('team/namespaces/list/continue', arg, 'team', 'api', 'rpc', 'team_data.member');
}; | Once a cursor has been retrieved from namespaces/list, use this to paginate
through all team-accessible namespaces. Duplicates may occur in the list.
Route attributes:
scope: team_data.member
@function Dropbox#teamNamespacesListContinue
@arg {TeamTeamNamespacesListContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<TeamTeamNamespacesListResult>, DropboxResponseError.<TeamTeamNamespacesListContinueError>>} | routes.teamNamespacesListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.teamPropertiesTemplateAdd = function (arg) {
return this.request('team/properties/template/add', arg, 'team', 'api', 'rpc', 'files.team_metadata.write');
}; | Permission : Team member file access.
Route attributes:
scope: files.team_metadata.write
@function Dropbox#teamPropertiesTemplateAdd
@deprecated
@arg {FilePropertiesAddTemplateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilePropertiesAddTemplateResult>, DropboxResponseError.<FilePropertiesModifyTemplateError>>} | routes.teamPropertiesTemplateAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.