DBTEAMTeamAuthRoutes Class Reference


                    
                    
                    client

An instance of the networking client that each route will use to submit a request.

Declaration

Objective-C

@property (nonatomic, readonly) id<DBTransportClient> _Nonnull client;


                    
                    
                    -init:

Initializes the DBTEAMTeamAuthRoutes namespace container object with a networking client.

Declaration

Objective-C

- (nonnull instancetype)init:(nonnull id<DBTransportClient>)client;


                    
                    
                    -devicesListMemberDevices:

List all device sessions of a team’s member.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListMemberDevicesResult *,
                     DBTEAMListMemberDevicesError *> *)devicesListMemberDevices:
    (nonnull NSString *)teamMemberId;

Swift

func devicesListMemberDevices(_ teamMemberId: String) -> DBRpcTask<DBTEAMListMemberDevicesResult, DBTEAMListMemberDevicesError>

Parameters


                                teamMemberId

The team’s member id.

Return Value

Through the response callback, the caller will receive a DBTEAMListMemberDevicesResult object on success or a DBTEAMListMemberDevicesError object on failure.


                    
                    
                    -devicesListMemberDevices:includeWebSessions:includeDesktopClients:includeMobileClients:

List all device sessions of a team’s member.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListMemberDevicesResult *,
                     DBTEAMListMemberDevicesError *> *)
    devicesListMemberDevices:(nonnull NSString *)teamMemberId
          includeWebSessions:(nullable NSNumber *)includeWebSessions
       includeDesktopClients:(nullable NSNumber *)includeDesktopClients
        includeMobileClients:(nullable NSNumber *)includeMobileClients;

Swift

func devicesListMemberDevices(_ teamMemberId: String, includeWebSessions: NSNumber?, includeDesktopClients: NSNumber?, includeMobileClients: NSNumber?) -> DBRpcTask<DBTEAMListMemberDevicesResult, DBTEAMListMemberDevicesError>

Parameters

`teamMemberId`	The team’s member id.
`includeWebSessions`	Whether to list web sessions of the team’s member.
`includeDesktopClients`	Whether to list linked desktop devices of the team’s member.
`includeMobileClients`	Whether to list linked mobile devices of the team’s member.

Return Value

Through the response callback, the caller will receive a DBTEAMListMemberDevicesResult object on success or a DBTEAMListMemberDevicesError object on failure.


                    
                    
                    -devicesListMembersDevices

List all device sessions of a team. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListMembersDevicesResult *,
                     DBTEAMListMembersDevicesError *> *)
    devicesListMembersDevices;

Swift

func devicesListMembersDevices() -> DBRpcTask<DBTEAMListMembersDevicesResult, DBTEAMListMembersDevicesError>

Return Value

Through the response callback, the caller will receive a DBTEAMListMembersDevicesResult object on success or a DBTEAMListMembersDevicesError object on failure.


                    
                    
                    -devicesListMembersDevices:includeWebSessions:includeDesktopClients:includeMobileClients:

List all device sessions of a team. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListMembersDevicesResult *,
                     DBTEAMListMembersDevicesError *> *)
    devicesListMembersDevices:(nullable NSString *)cursor
           includeWebSessions:(nullable NSNumber *)includeWebSessions
        includeDesktopClients:(nullable NSNumber *)includeDesktopClients
         includeMobileClients:(nullable NSNumber *)includeMobileClients;

Swift

func devicesListMembersDevices(_ cursor: String?, includeWebSessions: NSNumber?, includeDesktopClients: NSNumber?, includeMobileClients: NSNumber?) -> DBRpcTask<DBTEAMListMembersDevicesResult, DBTEAMListMembersDevicesError>

Parameters

`cursor`	At the first call to the `devicesListMembersDevices` the cursor shouldn’t be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices.
`includeWebSessions`	Whether to list web sessions of the team members.
`includeDesktopClients`	Whether to list desktop clients of the team members.
`includeMobileClients`	Whether to list mobile clients of the team members.

Return Value

Through the response callback, the caller will receive a DBTEAMListMembersDevicesResult object on success or a DBTEAMListMembersDevicesError object on failure.


                    
                    
                    -devicesListTeamDevices

Deprecated

devicesListTeamDevices is deprecated. Use devicesListMembersDevices.

DEPRECATED: List all device sessions of a team. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListTeamDevicesResult *,
                     DBTEAMListTeamDevicesError *> *)devicesListTeamDevices;

Swift

func devicesListTeamDevices() -> DBRpcTask<DBTEAMListTeamDevicesResult, DBTEAMListTeamDevicesError>

Return Value

Through the response callback, the caller will receive a DBTEAMListTeamDevicesResult object on success or a DBTEAMListTeamDevicesError object on failure.


                    
                    
                    -devicesListTeamDevices:includeWebSessions:includeDesktopClients:includeMobileClients:

Deprecated

devicesListTeamDevices is deprecated. Use devicesListMembersDevices.

DEPRECATED: List all device sessions of a team. Permission : Team member file access.

Declaration

Objective-C

- (nonnull
       DBRpcTask<DBTEAMListTeamDevicesResult *, DBTEAMListTeamDevicesError *> *)
    devicesListTeamDevices:(nullable NSString *)cursor
        includeWebSessions:(nullable NSNumber *)includeWebSessions
     includeDesktopClients:(nullable NSNumber *)includeDesktopClients
      includeMobileClients:(nullable NSNumber *)includeMobileClients;

Swift

func devicesListTeamDevices(_ cursor: String?, includeWebSessions: NSNumber?, includeDesktopClients: NSNumber?, includeMobileClients: NSNumber?) -> DBRpcTask<DBTEAMListTeamDevicesResult, DBTEAMListTeamDevicesError>

Parameters

`cursor`	At the first call to the `devicesListTeamDevices` the cursor shouldn’t be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices.
`includeWebSessions`	Whether to list web sessions of the team members.
`includeDesktopClients`	Whether to list desktop clients of the team members.
`includeMobileClients`	Whether to list mobile clients of the team members.

Return Value

Through the response callback, the caller will receive a DBTEAMListTeamDevicesResult object on success or a DBTEAMListTeamDevicesError object on failure.


                    
                    
                    -devicesRevokeDeviceSession:

Revoke a device session of a team’s member.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMRevokeDeviceSessionError *> *)
    devicesRevokeDeviceSession:
        (nonnull DBTEAMRevokeDeviceSessionArg *)revokeDeviceSessionArg;

Swift

func devicesRevokeDeviceSession(_ revokeDeviceSessionArg: DBTEAMRevokeDeviceSessionArg) -> DBRpcTask<DBNilObject, DBTEAMRevokeDeviceSessionError>

Parameters


                                revokeDeviceSessionArg

The RevokeDeviceSessionArg union

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMRevokeDeviceSessionError object on failure.


                    
                    
                    -devicesRevokeDeviceSessionBatch:

Revoke a list of device sessions of team members.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMRevokeDeviceSessionBatchResult *,
                     DBTEAMRevokeDeviceSessionBatchError *> *)
    devicesRevokeDeviceSessionBatch:
        (nonnull NSArray<DBTEAMRevokeDeviceSessionArg *> *)revokeDevices;

Swift

func devicesRevokeDeviceSessionBatch(_ revokeDevices: [DBTEAMRevokeDeviceSessionArg]) -> DBRpcTask<DBTEAMRevokeDeviceSessionBatchResult, DBTEAMRevokeDeviceSessionBatchError>

Return Value

Through the response callback, the caller will receive a DBTEAMRevokeDeviceSessionBatchResult object on success or a DBTEAMRevokeDeviceSessionBatchError object on failure.


                    
                    
                    -featuresGetValues:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMFeaturesGetValuesBatchResult *,
                     DBTEAMFeaturesGetValuesBatchError *> *)featuresGetValues:
    (nonnull NSArray<DBTEAMFeature *> *)features;

Swift

func featuresGetValues(_ features: [DBTEAMFeature]) -> DBRpcTask<DBTEAMFeaturesGetValuesBatchResult, DBTEAMFeaturesGetValuesBatchError>

Parameters


                                features

A list of features in Feature. If the list is empty, this route will return FeaturesGetValuesBatchError.

Return Value

Through the response callback, the caller will receive a DBTEAMFeaturesGetValuesBatchResult object on success or a DBTEAMFeaturesGetValuesBatchError object on failure.


                    
                    
                    -getInfo

Retrieves information about a team.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamGetInfoResult *, DBNilObject *> *)getInfo;

Swift

func getInfo() -> DBRpcTask<DBTEAMTeamGetInfoResult, DBNilObject>

Return Value

Through the response callback, the caller will receive a DBTEAMTeamGetInfoResult object on success or a void object on failure.


                    
                    
                    -groupsCreate:

Creates a new, empty group, with a requested name. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupFullInfo *, DBTEAMGroupCreateError *> *)
    groupsCreate:(nonnull NSString *)groupName;

Swift

func groupsCreate(_ groupName: String) -> DBRpcTask<DBTEAMGroupFullInfo, DBTEAMGroupCreateError>

Parameters


                                groupName

Group name.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupFullInfo object on success or a DBTEAMGroupCreateError object on failure.


                    
                    
                    -groupsCreate:addCreatorAsOwner:groupExternalId:groupManagementType:

Creates a new, empty group, with a requested name. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupFullInfo *, DBTEAMGroupCreateError *> *)
           groupsCreate:(nonnull NSString *)groupName
      addCreatorAsOwner:(nullable NSNumber *)addCreatorAsOwner
        groupExternalId:(nullable NSString *)groupExternalId
    groupManagementType:
        (nullable DBTEAMCOMMONGroupManagementType *)groupManagementType;

Swift

func groupsCreate(_ groupName: String, addCreatorAsOwner: NSNumber?, groupExternalId: String?, groupManagementType: DBTEAMCOMMONGroupManagementType?) -> DBRpcTask<DBTEAMGroupFullInfo, DBTEAMGroupCreateError>

Parameters

`groupName`	Group name.
`addCreatorAsOwner`	Automatically add the creator of the group.
`groupExternalId`	The creator of a team can associate an arbitrary external ID to the group.
`groupManagementType`	Whether the team can be managed by selected users, or only by team admins.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupFullInfo object on success or a DBTEAMGroupCreateError object on failure.


                    
                    
                    -groupsDelete:

Deletes a group. The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet to determine whether this process has completed. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBASYNCLaunchEmptyResult *, DBTEAMGroupDeleteError *> *)
    groupsDelete:(nonnull DBTEAMGroupSelector *)groupSelector;

Swift

func groupsDelete(_ groupSelector: DBTEAMGroupSelector) -> DBRpcTask<DBASYNCLaunchEmptyResult, DBTEAMGroupDeleteError>

Parameters


                                groupSelector

Argument for selecting a single group, either by group_id or by external group ID.

Return Value

Through the response callback, the caller will receive a DBASYNCLaunchEmptyResult object on success or a DBTEAMGroupDeleteError object on failure.


                    
                    
                    -groupsGetInfo:

Retrieves information about one or more groups. Note that the optional field members in DBTEAMGroupFullInfo is not returned for system-managed groups. Permission : Team Information.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMGroupsGetInfoItem *> *,
                     DBTEAMGroupsGetInfoError *> *)groupsGetInfo:
    (nonnull DBTEAMGroupsSelector *)groupsSelector;

Swift

func groupsGetInfo(_ groupsSelector: DBTEAMGroupsSelector) -> DBRpcTask<NSArray, DBTEAMGroupsGetInfoError>

Parameters


                                groupsSelector

Argument for selecting a list of groups, either by group_ids, or external group IDs.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMGroupsGetInfoItem *> object on success or a DBTEAMGroupsGetInfoError object on failure.


                    
                    
                    -groupsJobStatusGet:

Once an async_job_id is returned from groupsDelete, groupsMembersAdd , or groupsMembersRemove use this method to poll the status of granting/revoking group members’ access to group-owned resources. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBASYNCPollEmptyResult *, DBTEAMGroupsPollError *> *)
    groupsJobStatusGet:(nonnull NSString *)asyncJobId;

Swift

func groupsJobStatusGet(_ asyncJobId: String) -> DBRpcTask<DBASYNCPollEmptyResult, DBTEAMGroupsPollError>

Parameters


                                asyncJobId

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Return Value

Through the response callback, the caller will receive a DBASYNCPollEmptyResult object on success or a DBTEAMGroupsPollError object on failure.


                    
                    
                    -groupsList

Lists groups on a team. Permission : Team Information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupsListResult *, DBNilObject *> *)groupsList;

Swift

func groupsList() -> DBRpcTask<DBTEAMGroupsListResult, DBNilObject>

Return Value

Through the response callback, the caller will receive a DBTEAMGroupsListResult object on success or a void object on failure.


                    
                    
                    -groupsList:

Lists groups on a team. Permission : Team Information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupsListResult *, DBNilObject *> *)groupsList:
    (nullable NSNumber *)limit;

Swift

func groupsList(_ limit: NSNumber?) -> DBRpcTask<DBTEAMGroupsListResult, DBNilObject>

Parameters


                                limit

Number of results to return per call.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupsListResult object on success or a void object on failure.


                    
                    
                    -groupsListContinue:

Once a cursor has been retrieved from groupsList, use this to paginate through all groups. Permission : Team Information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupsListResult *, DBTEAMGroupsListContinueError *>
       *)groupsListContinue:(nonnull NSString *)cursor;

Swift

func groupsListContinue(_ cursor: String) -> DBRpcTask<DBTEAMGroupsListResult, DBTEAMGroupsListContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of groups.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupsListResult object on success or a DBTEAMGroupsListContinueError object on failure.


                    
                    
                    -groupsMembersAdd:members:

Adds members to a group. The members are added immediately. However the granting of group-owned resources may take additional time. Use the groupsJobStatusGet to determine whether this process has completed. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupMembersChangeResult *,
                     DBTEAMGroupMembersAddError *> *)
    groupsMembersAdd:(nonnull DBTEAMGroupSelector *)group
             members:(nonnull NSArray<DBTEAMMemberAccess *> *)members;

Swift

func groupsMembersAdd(_ group: DBTEAMGroupSelector, members: [DBTEAMMemberAccess]) -> DBRpcTask<DBTEAMGroupMembersChangeResult, DBTEAMGroupMembersAddError>

Parameters

`group`	Group to which users will be added.
`members`	List of users to be added to the group.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupMembersChangeResult object on success or a DBTEAMGroupMembersAddError object on failure.


                    
                    
                    -groupsMembersAdd:members:returnMembers:

Adds members to a group. The members are added immediately. However the granting of group-owned resources may take additional time. Use the groupsJobStatusGet to determine whether this process has completed. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupMembersChangeResult *,
                     DBTEAMGroupMembersAddError *> *)
    groupsMembersAdd:(nonnull DBTEAMGroupSelector *)group
             members:(nonnull NSArray<DBTEAMMemberAccess *> *)members
       returnMembers:(nullable NSNumber *)returnMembers;

Swift

func groupsMembersAdd(_ group: DBTEAMGroupSelector, members: [DBTEAMMemberAccess], returnMembers: NSNumber?) -> DBRpcTask<DBTEAMGroupMembersChangeResult, DBTEAMGroupMembersAddError>

Parameters

`group`	Group to which users will be added.
`members`	List of users to be added to the group.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupMembersChangeResult object on success or a DBTEAMGroupMembersAddError object on failure.


                    
                    
                    -groupsMembersList:

Lists members of a group. Permission : Team Information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupsMembersListResult *,
                     DBTEAMGroupSelectorError *> *)groupsMembersList:
    (nonnull DBTEAMGroupSelector *)group;

Swift

func groupsMembersList(_ group: DBTEAMGroupSelector) -> DBRpcTask<DBTEAMGroupsMembersListResult, DBTEAMGroupSelectorError>

Parameters


                                group

The group whose members are to be listed.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupsMembersListResult object on success or a DBTEAMGroupSelectorError object on failure.


                    
                    
                    -groupsMembersList:limit:

Lists members of a group. Permission : Team Information.

Declaration

Objective-C

- (nonnull
       DBRpcTask<DBTEAMGroupsMembersListResult *, DBTEAMGroupSelectorError *> *)
    groupsMembersList:(nonnull DBTEAMGroupSelector *)group
                limit:(nullable NSNumber *)limit;

Swift

func groupsMembersList(_ group: DBTEAMGroupSelector, limit: NSNumber?) -> DBRpcTask<DBTEAMGroupsMembersListResult, DBTEAMGroupSelectorError>

Parameters

`group`	The group whose members are to be listed.
`limit`	Number of results to return per call.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupsMembersListResult object on success or a DBTEAMGroupSelectorError object on failure.


                    
                    
                    -groupsMembersListContinue:

Once a cursor has been retrieved from groupsMembersList, use this to paginate through all members of the group. Permission : Team information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupsMembersListResult *,
                     DBTEAMGroupsMembersListContinueError *> *)
    groupsMembersListContinue:(nonnull NSString *)cursor;

Swift

func groupsMembersListContinue(_ cursor: String) -> DBRpcTask<DBTEAMGroupsMembersListResult, DBTEAMGroupsMembersListContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of groups.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupsMembersListResult object on success or a DBTEAMGroupsMembersListContinueError object on failure.


                    
                    
                    -groupsMembersRemove:users:

Removes members from a group. The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet 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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupMembersChangeResult *,
                     DBTEAMGroupMembersRemoveError *> *)
    groupsMembersRemove:(nonnull DBTEAMGroupSelector *)group
                  users:(nonnull NSArray<DBTEAMUserSelectorArg *> *)users;

Swift

func groupsMembersRemove(_ group: DBTEAMGroupSelector, users: [DBTEAMUserSelectorArg]) -> DBRpcTask<DBTEAMGroupMembersChangeResult, DBTEAMGroupMembersRemoveError>

Parameters

`group`	Group from which users will be removed.
`users`	List of users to be removed from the group.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupMembersChangeResult object on success or a DBTEAMGroupMembersRemoveError object on failure.


                    
                    
                    -groupsMembersRemove:users:returnMembers:

Removes members from a group. The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groupsJobStatusGet 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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupMembersChangeResult *,
                     DBTEAMGroupMembersRemoveError *> *)
    groupsMembersRemove:(nonnull DBTEAMGroupSelector *)group
                  users:(nonnull NSArray<DBTEAMUserSelectorArg *> *)users
          returnMembers:(nullable NSNumber *)returnMembers;

Swift

func groupsMembersRemove(_ group: DBTEAMGroupSelector, users: [DBTEAMUserSelectorArg], returnMembers: NSNumber?) -> DBRpcTask<DBTEAMGroupMembersChangeResult, DBTEAMGroupMembersRemoveError>

Parameters

`group`	Group from which users will be removed.
`users`	List of users to be removed from the group.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupMembersChangeResult object on success or a DBTEAMGroupMembersRemoveError object on failure.


                    
                    
                    -groupsMembersSetAccessType:user:accessType:

Sets a member’s access type in a group. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMGroupsGetInfoItem *> *,
                     DBTEAMGroupMemberSetAccessTypeError *> *)
    groupsMembersSetAccessType:(nonnull DBTEAMGroupSelector *)group
                          user:(nonnull DBTEAMUserSelectorArg *)user
                    accessType:(nonnull DBTEAMGroupAccessType *)accessType;

Swift

func groupsMembersSetAccessType(_ group: DBTEAMGroupSelector, user: DBTEAMUserSelectorArg, accessType: DBTEAMGroupAccessType) -> DBRpcTask<NSArray, DBTEAMGroupMemberSetAccessTypeError>

Parameters


                                accessType

New group access type the user will have.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMGroupsGetInfoItem *> object on success or a DBTEAMGroupMemberSetAccessTypeError object on failure.


                    
                    
                    -groupsMembersSetAccessType:user:accessType:returnMembers:

Sets a member’s access type in a group. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMGroupsGetInfoItem *> *,
                     DBTEAMGroupMemberSetAccessTypeError *> *)
    groupsMembersSetAccessType:(nonnull DBTEAMGroupSelector *)group
                          user:(nonnull DBTEAMUserSelectorArg *)user
                    accessType:(nonnull DBTEAMGroupAccessType *)accessType
                 returnMembers:(nullable NSNumber *)returnMembers;

Swift

func groupsMembersSetAccessType(_ group: DBTEAMGroupSelector, user: DBTEAMUserSelectorArg, accessType: DBTEAMGroupAccessType, returnMembers: NSNumber?) -> DBRpcTask<NSArray, DBTEAMGroupMemberSetAccessTypeError>

Parameters

`accessType`	New group access type the user will have.
`returnMembers`	Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMGroupsGetInfoItem *> object on success or a DBTEAMGroupMemberSetAccessTypeError object on failure.


                    
                    
                    -groupsUpdate:

Updates a group’s name and/or external ID. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupFullInfo *, DBTEAMGroupUpdateError *> *)
    groupsUpdate:(nonnull DBTEAMGroupSelector *)group;

Swift

func groupsUpdate(_ group: DBTEAMGroupSelector) -> DBRpcTask<DBTEAMGroupFullInfo, DBTEAMGroupUpdateError>

Parameters


                                group

Specify a group.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupFullInfo object on success or a DBTEAMGroupUpdateError object on failure.


                    
                    
                    -groupsUpdate:returnMembers:dNewGroupName:dNewGroupExternalId:dNewGroupManagementType:

Updates a group’s name and/or external ID. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGroupFullInfo *, DBTEAMGroupUpdateError *> *)
               groupsUpdate:(nonnull DBTEAMGroupSelector *)group
              returnMembers:(nullable NSNumber *)returnMembers
              dNewGroupName:(nullable NSString *)dNewGroupName
        dNewGroupExternalId:(nullable NSString *)dNewGroupExternalId
    dNewGroupManagementType:
        (nullable DBTEAMCOMMONGroupManagementType *)dNewGroupManagementType;

Swift

func groupsUpdate(_ group: DBTEAMGroupSelector, returnMembers: NSNumber?, dNewGroupName: String?, dNewGroupExternalId: String?, dNewGroupManagementType: DBTEAMCOMMONGroupManagementType?) -> DBRpcTask<DBTEAMGroupFullInfo, DBTEAMGroupUpdateError>

Parameters

`group`	Specify a group.
`dNewGroupName`	Optional argument. Set group name to this if provided.
`dNewGroupExternalId`	Optional argument. New group external ID. If the argument is None, the group’s external_id won’t be updated. If the argument is empty string, the group’s external id will be cleared.
`dNewGroupManagementType`	Set new group management type, if provided.

Return Value

Through the response callback, the caller will receive a DBTEAMGroupFullInfo object on success or a DBTEAMGroupUpdateError object on failure.


                    
                    
                    -legalHoldsCreatePolicy:members:

Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldPolicy *,
                     DBTEAMLegalHoldsPolicyCreateError *> *)
    legalHoldsCreatePolicy:(nonnull NSString *)name
                   members:(nonnull NSArray<NSString *> *)members;

Swift

func legalHoldsCreatePolicy(_ name: String, members: [String]) -> DBRpcTask<DBTEAMLegalHoldPolicy, DBTEAMLegalHoldsPolicyCreateError>

Parameters

`name`	Policy name.
`members`	List of team member IDs added to the hold.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldPolicy object on success or a DBTEAMLegalHoldsPolicyCreateError object on failure.


                    
                    
                    -legalHoldsCreatePolicy:members:description_:startDate:endDate:

Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldPolicy *,
                     DBTEAMLegalHoldsPolicyCreateError *> *)
    legalHoldsCreatePolicy:(nonnull NSString *)name
                   members:(nonnull NSArray<NSString *> *)members
              description_:(nullable NSString *)description_
                 startDate:(nullable NSDate *)startDate
                   endDate:(nullable NSDate *)endDate;

Swift

func legalHoldsCreatePolicy(_ name: String, members: [String], description_: String?, start startDate: Date?, end endDate: Date?) -> DBRpcTask<DBTEAMLegalHoldPolicy, DBTEAMLegalHoldsPolicyCreateError>

Parameters

`name`	Policy name.
`description_`	A description of the legal hold policy.
`members`	List of team member IDs added to the hold.
`startDate`	start date of the legal hold policy.
`endDate`	end date of the legal hold policy.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldPolicy object on success or a DBTEAMLegalHoldsPolicyCreateError object on failure.


                    
                    
                    -legalHoldsGetPolicy:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldPolicy *, DBTEAMLegalHoldsGetPolicyError *>
       *)legalHoldsGetPolicy:(nonnull NSString *)id_;

Swift

func legalHoldsGetPolicy(_ id_: String) -> DBRpcTask<DBTEAMLegalHoldPolicy, DBTEAMLegalHoldsGetPolicyError>

Parameters

id_

The legal hold Id.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldPolicy object on success or a DBTEAMLegalHoldsGetPolicyError object on failure.


                    
                    
                    -legalHoldsListHeldRevisions:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldsListHeldRevisionResult *,
                     DBTEAMLegalHoldsListHeldRevisionsError *> *)
    legalHoldsListHeldRevisions:(nonnull NSString *)id_;

Swift

func legalHoldsListHeldRevisions(_ id_: String) -> DBRpcTask<DBTEAMLegalHoldsListHeldRevisionResult, DBTEAMLegalHoldsListHeldRevisionsError>

Parameters

id_

The legal hold Id.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldsListHeldRevisionResult object on success or a DBTEAMLegalHoldsListHeldRevisionsError object on failure.


                    
                    
                    -legalHoldsListHeldRevisionsContinue:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldsListHeldRevisionResult *,
                     DBTEAMLegalHoldsListHeldRevisionsError *> *)
    legalHoldsListHeldRevisionsContinue:(nonnull NSString *)id_;

Swift

func legalHoldsListHeldRevisionsContinue(_ id_: String) -> DBRpcTask<DBTEAMLegalHoldsListHeldRevisionResult, DBTEAMLegalHoldsListHeldRevisionsError>

Parameters

id_

The legal hold Id.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldsListHeldRevisionResult object on success or a DBTEAMLegalHoldsListHeldRevisionsError object on failure.


                    
                    
                    -legalHoldsListHeldRevisionsContinue:cursor:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldsListHeldRevisionResult *,
                     DBTEAMLegalHoldsListHeldRevisionsError *> *)
    legalHoldsListHeldRevisionsContinue:(nonnull NSString *)id_
                                 cursor:(nullable NSString *)cursor;

Swift

func legalHoldsListHeldRevisionsContinue(_ id_: String, cursor: String?) -> DBRpcTask<DBTEAMLegalHoldsListHeldRevisionResult, DBTEAMLegalHoldsListHeldRevisionsError>

Parameters

`id_`	The legal hold Id.
`cursor`	The cursor idicates where to continue reading file metadata entries for the next API call. When there are no more entries, the cursor will return none.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldsListHeldRevisionResult object on success or a DBTEAMLegalHoldsListHeldRevisionsError object on failure.


                    
                    
                    -legalHoldsListPolicies

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldsListPoliciesResult *,
                     DBTEAMLegalHoldsListPoliciesError *> *)
    legalHoldsListPolicies;

Swift

func legalHoldsListPolicies() -> DBRpcTask<DBTEAMLegalHoldsListPoliciesResult, DBTEAMLegalHoldsListPoliciesError>

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldsListPoliciesResult object on success or a DBTEAMLegalHoldsListPoliciesError object on failure.


                    
                    
                    -legalHoldsListPolicies:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldsListPoliciesResult *,
                     DBTEAMLegalHoldsListPoliciesError *> *)
    legalHoldsListPolicies:(nullable NSNumber *)includeReleased;

Swift

func legalHoldsListPolicies(_ includeReleased: NSNumber?) -> DBRpcTask<DBTEAMLegalHoldsListPoliciesResult, DBTEAMLegalHoldsListPoliciesError>

Parameters


                                includeReleased

Whether to return holds that were released.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldsListPoliciesResult object on success or a DBTEAMLegalHoldsListPoliciesError object on failure.


                    
                    
                    -legalHoldsReleasePolicy:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMLegalHoldsPolicyReleaseError *> *)
    legalHoldsReleasePolicy:(nonnull NSString *)id_;

Swift

func legalHoldsReleasePolicy(_ id_: String) -> DBRpcTask<DBNilObject, DBTEAMLegalHoldsPolicyReleaseError>

Parameters

id_

The legal hold Id.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMLegalHoldsPolicyReleaseError object on failure.


                    
                    
                    -legalHoldsUpdatePolicy:

Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldPolicy *,
                     DBTEAMLegalHoldsPolicyUpdateError *> *)
    legalHoldsUpdatePolicy:(nonnull NSString *)id_;

Swift

func legalHoldsUpdatePolicy(_ id_: String) -> DBRpcTask<DBTEAMLegalHoldPolicy, DBTEAMLegalHoldsPolicyUpdateError>

Parameters

id_

The legal hold Id.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldPolicy object on success or a DBTEAMLegalHoldsPolicyUpdateError object on failure.


                    
                    
                    -legalHoldsUpdatePolicy:name:description_:members:

Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMLegalHoldPolicy *,
                     DBTEAMLegalHoldsPolicyUpdateError *> *)
    legalHoldsUpdatePolicy:(nonnull NSString *)id_
                      name:(nullable NSString *)name
              description_:(nullable NSString *)description_
                   members:(nullable NSArray<NSString *> *)members;

Swift

func legalHoldsUpdatePolicy(_ id_: String, name: String?, description_: String?, members: [String]?) -> DBRpcTask<DBTEAMLegalHoldPolicy, DBTEAMLegalHoldsPolicyUpdateError>

Parameters

`id_`	The legal hold Id.
`name`	Policy new name.
`description_`	Policy new description.
`members`	List of team member IDs to apply the policy on.

Return Value

Through the response callback, the caller will receive a DBTEAMLegalHoldPolicy object on success or a DBTEAMLegalHoldsPolicyUpdateError object on failure.


                    
                    
                    -linkedAppsListMemberLinkedApps:

List all linked applications of the team member. Note, this endpoint does not list any team-linked applications.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListMemberAppsResult *, DBTEAMListMemberAppsError *>
       *)linkedAppsListMemberLinkedApps:(nonnull NSString *)teamMemberId;

Swift

func linkedAppsListMemberLinkedApps(_ teamMemberId: String) -> DBRpcTask<DBTEAMListMemberAppsResult, DBTEAMListMemberAppsError>

Parameters


                                teamMemberId

The team member id.

Return Value

Through the response callback, the caller will receive a DBTEAMListMemberAppsResult object on success or a DBTEAMListMemberAppsError object on failure.


                    
                    
                    -linkedAppsListMembersLinkedApps

List all applications linked to the team members’ accounts. Note, this endpoint does not list any team-linked applications.

Declaration

Objective-C

- (nonnull
       DBRpcTask<DBTEAMListMembersAppsResult *, DBTEAMListMembersAppsError *> *)
    linkedAppsListMembersLinkedApps;

Swift

func linkedAppsListMembersLinkedApps() -> DBRpcTask<DBTEAMListMembersAppsResult, DBTEAMListMembersAppsError>

Return Value

Through the response callback, the caller will receive a DBTEAMListMembersAppsResult object on success or a DBTEAMListMembersAppsError object on failure.


                    
                    
                    -linkedAppsListMembersLinkedApps:

List all applications linked to the team members’ accounts. Note, this endpoint does not list any team-linked applications.

Declaration

Objective-C

- (nonnull
       DBRpcTask<DBTEAMListMembersAppsResult *, DBTEAMListMembersAppsError *> *)
    linkedAppsListMembersLinkedApps:(nullable NSString *)cursor;

Swift

func linkedAppsListMembersLinkedApps(_ cursor: String?) -> DBRpcTask<DBTEAMListMembersAppsResult, DBTEAMListMembersAppsError>

Parameters


                                cursor

At the first call to the linkedAppsListMembersLinkedApps the cursor shouldn’t be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.

Return Value

Through the response callback, the caller will receive a DBTEAMListMembersAppsResult object on success or a DBTEAMListMembersAppsError object on failure.


                    
                    
                    -linkedAppsListTeamLinkedApps

Deprecated

linkedAppsListTeamLinkedApps is deprecated. Use linkedAppsListMembersLinkedApps.

DEPRECATED: List all applications linked to the team members’ accounts. Note, this endpoint doesn’t list any team-linked applications.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListTeamAppsResult *, DBTEAMListTeamAppsError *> *)
    linkedAppsListTeamLinkedApps;

Swift

func linkedAppsListTeamLinkedApps() -> DBRpcTask<DBTEAMListTeamAppsResult, DBTEAMListTeamAppsError>

Return Value

Through the response callback, the caller will receive a DBTEAMListTeamAppsResult object on success or a DBTEAMListTeamAppsError object on failure.


                    
                    
                    -linkedAppsListTeamLinkedApps:

Deprecated

linkedAppsListTeamLinkedApps is deprecated. Use linkedAppsListMembersLinkedApps.

DEPRECATED: List all applications linked to the team members’ accounts. Note, this endpoint doesn’t list any team-linked applications.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMListTeamAppsResult *, DBTEAMListTeamAppsError *> *)
    linkedAppsListTeamLinkedApps:(nullable NSString *)cursor;

Swift

func linkedAppsListTeamLinkedApps(_ cursor: String?) -> DBRpcTask<DBTEAMListTeamAppsResult, DBTEAMListTeamAppsError>

Parameters


                                cursor

At the first call to the linkedAppsListTeamLinkedApps the cursor shouldn’t be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications.

Return Value

Through the response callback, the caller will receive a DBTEAMListTeamAppsResult object on success or a DBTEAMListTeamAppsError object on failure.


                    
                    
                    -linkedAppsRevokeLinkedApp:teamMemberId:

Revoke a linked application of the team member.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMRevokeLinkedAppError *> *)
    linkedAppsRevokeLinkedApp:(nonnull NSString *)appId
                 teamMemberId:(nonnull NSString *)teamMemberId;

Swift

func linkedAppsRevokeLinkedApp(_ appId: String, teamMemberId: String) -> DBRpcTask<DBNilObject, DBTEAMRevokeLinkedAppError>

Parameters

`appId`	The application’s unique id.
`teamMemberId`	The unique id of the member owning the device.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMRevokeLinkedAppError object on failure.


                    
                    
                    -linkedAppsRevokeLinkedApp:teamMemberId:keepAppFolder:

Revoke a linked application of the team member.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMRevokeLinkedAppError *> *)
    linkedAppsRevokeLinkedApp:(nonnull NSString *)appId
                 teamMemberId:(nonnull NSString *)teamMemberId
                keepAppFolder:(nullable NSNumber *)keepAppFolder;

Swift

func linkedAppsRevokeLinkedApp(_ appId: String, teamMemberId: String, keepAppFolder: NSNumber?) -> DBRpcTask<DBNilObject, DBTEAMRevokeLinkedAppError>

Parameters

`appId`	The application’s unique id.
`teamMemberId`	The unique id of the member owning the device.
`keepAppFolder`	This flag is not longer supported, the application dedicated folder (in case the application uses one) will be kept.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMRevokeLinkedAppError object on failure.


                    
                    
                    -linkedAppsRevokeLinkedAppBatch:

Revoke a list of linked applications of the team members.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMRevokeLinkedAppBatchResult *,
                     DBTEAMRevokeLinkedAppBatchError *> *)
    linkedAppsRevokeLinkedAppBatch:
        (nonnull NSArray<DBTEAMRevokeLinkedApiAppArg *> *)revokeLinkedApp;

Swift

func linkedAppsRevokeLinkedAppBatch(_ revokeLinkedApp: [DBTEAMRevokeLinkedApiAppArg]) -> DBRpcTask<DBTEAMRevokeLinkedAppBatchResult, DBTEAMRevokeLinkedAppBatchError>

Return Value

Through the response callback, the caller will receive a DBTEAMRevokeLinkedAppBatchResult object on success or a DBTEAMRevokeLinkedAppBatchError object on failure.


                    
                    
                    -memberSpaceLimitsExcludedUsersAdd

Add users to member space limits excluded users list.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMExcludedUsersUpdateResult *,
                     DBTEAMExcludedUsersUpdateError *> *)
    memberSpaceLimitsExcludedUsersAdd;

Swift

func memberSpaceLimitsExcludedUsersAdd() -> DBRpcTask<DBTEAMExcludedUsersUpdateResult, DBTEAMExcludedUsersUpdateError>

Return Value

Through the response callback, the caller will receive a DBTEAMExcludedUsersUpdateResult object on success or a DBTEAMExcludedUsersUpdateError object on failure.


                    
                    
                    -memberSpaceLimitsExcludedUsersAdd:

Add users to member space limits excluded users list.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMExcludedUsersUpdateResult *,
                     DBTEAMExcludedUsersUpdateError *> *)
    memberSpaceLimitsExcludedUsersAdd:
        (nullable NSArray<DBTEAMUserSelectorArg *> *)users;

Swift

func memberSpaceLimitsExcludedUsersAdd(_ users: [DBTEAMUserSelectorArg]?) -> DBRpcTask<DBTEAMExcludedUsersUpdateResult, DBTEAMExcludedUsersUpdateError>

Parameters


                                users

List of users to be added/removed.

Return Value

Through the response callback, the caller will receive a DBTEAMExcludedUsersUpdateResult object on success or a DBTEAMExcludedUsersUpdateError object on failure.


                    
                    
                    -memberSpaceLimitsExcludedUsersList

List member space limits excluded users.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMExcludedUsersListResult *,
                     DBTEAMExcludedUsersListError *> *)
    memberSpaceLimitsExcludedUsersList;

Swift

func memberSpaceLimitsExcludedUsersList() -> DBRpcTask<DBTEAMExcludedUsersListResult, DBTEAMExcludedUsersListError>

Return Value

Through the response callback, the caller will receive a DBTEAMExcludedUsersListResult object on success or a DBTEAMExcludedUsersListError object on failure.


                    
                    
                    -memberSpaceLimitsExcludedUsersList:

List member space limits excluded users.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMExcludedUsersListResult *,
                     DBTEAMExcludedUsersListError *> *)
    memberSpaceLimitsExcludedUsersList:(nullable NSNumber *)limit;

Swift

func memberSpaceLimitsExcludedUsersList(_ limit: NSNumber?) -> DBRpcTask<DBTEAMExcludedUsersListResult, DBTEAMExcludedUsersListError>

Parameters


                                limit

Number of results to return per call.

Return Value

Through the response callback, the caller will receive a DBTEAMExcludedUsersListResult object on success or a DBTEAMExcludedUsersListError object on failure.


                    
                    
                    -memberSpaceLimitsExcludedUsersListContinue:

Continue listing member space limits excluded users.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMExcludedUsersListResult *,
                     DBTEAMExcludedUsersListContinueError *> *)
    memberSpaceLimitsExcludedUsersListContinue:(nonnull NSString *)cursor;

Swift

func memberSpaceLimitsExcludedUsersListContinue(_ cursor: String) -> DBRpcTask<DBTEAMExcludedUsersListResult, DBTEAMExcludedUsersListContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of users.

Return Value

Through the response callback, the caller will receive a DBTEAMExcludedUsersListResult object on success or a DBTEAMExcludedUsersListContinueError object on failure.


                    
                    
                    -memberSpaceLimitsExcludedUsersRemove

Remove users from member space limits excluded users list.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMExcludedUsersUpdateResult *,
                     DBTEAMExcludedUsersUpdateError *> *)
    memberSpaceLimitsExcludedUsersRemove;

Swift

func memberSpaceLimitsExcludedUsersRemove() -> DBRpcTask<DBTEAMExcludedUsersUpdateResult, DBTEAMExcludedUsersUpdateError>

Return Value

Through the response callback, the caller will receive a DBTEAMExcludedUsersUpdateResult object on success or a DBTEAMExcludedUsersUpdateError object on failure.


                    
                    
                    -memberSpaceLimitsExcludedUsersRemove:

Remove users from member space limits excluded users list.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMExcludedUsersUpdateResult *,
                     DBTEAMExcludedUsersUpdateError *> *)
    memberSpaceLimitsExcludedUsersRemove:
        (nullable NSArray<DBTEAMUserSelectorArg *> *)users;

Swift

func memberSpaceLimitsExcludedUsersRemove(_ users: [DBTEAMUserSelectorArg]?) -> DBRpcTask<DBTEAMExcludedUsersUpdateResult, DBTEAMExcludedUsersUpdateError>

Parameters


                                users

List of users to be added/removed.

Return Value

Through the response callback, the caller will receive a DBTEAMExcludedUsersUpdateResult object on success or a DBTEAMExcludedUsersUpdateError object on failure.


                    
                    
                    -memberSpaceLimitsGetCustomQuota:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMCustomQuotaResult *> *,
                     DBTEAMCustomQuotaError *> *)
    memberSpaceLimitsGetCustomQuota:
        (nonnull NSArray<DBTEAMUserSelectorArg *> *)users;

Swift

func memberSpaceLimitsGetCustomQuota(_ users: [DBTEAMUserSelectorArg]) -> DBRpcTask<NSArray, DBTEAMCustomQuotaError>

Parameters


                                users

List of users.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMCustomQuotaResult *> object on success or a DBTEAMCustomQuotaError object on failure.


                    
                    
                    -memberSpaceLimitsRemoveCustomQuota:

Remove users custom quota. A maximum of 1000 members can be specified in a single call.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMRemoveCustomQuotaResult *> *,
                     DBTEAMCustomQuotaError *> *)
    memberSpaceLimitsRemoveCustomQuota:
        (nonnull NSArray<DBTEAMUserSelectorArg *> *)users;

Swift

func memberSpaceLimitsRemoveCustomQuota(_ users: [DBTEAMUserSelectorArg]) -> DBRpcTask<NSArray, DBTEAMCustomQuotaError>

Parameters


                                users

List of users.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMRemoveCustomQuotaResult *> object on success or a DBTEAMCustomQuotaError object on failure.


                    
                    
                    -memberSpaceLimitsSetCustomQuota:

Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMCustomQuotaResult *> *,
                     DBTEAMSetCustomQuotaError *> *)
    memberSpaceLimitsSetCustomQuota:
        (nonnull NSArray<DBTEAMUserCustomQuotaArg *> *)usersAndQuotas;

Swift

func memberSpaceLimitsSetCustomQuota(_ usersAndQuotas: [DBTEAMUserCustomQuotaArg]) -> DBRpcTask<NSArray, DBTEAMSetCustomQuotaError>

Parameters


                                usersAndQuotas

List of users and their custom quotas.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMCustomQuotaResult *> object on success or a DBTEAMSetCustomQuotaError object on failure.


                    
                    
                    -membersAddV2:

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’.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersAddLaunchV2Result *, DBNilObject *> *)
    membersAddV2:(nonnull NSArray<DBTEAMMemberAddV2Arg *> *)dNewMembers;

Swift

func membersAddV2(_ dNewMembers: [DBTEAMMemberAddV2Arg]) -> DBRpcTask<DBTEAMMembersAddLaunchV2Result, DBNilObject>

Parameters


                                dNewMembers

Details of new members to be added to the team.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersAddLaunchV2Result object on success or a void object on failure.


                    
                    
                    -membersAddV2:forceAsync:

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’.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersAddLaunchV2Result *, DBNilObject *> *)
    membersAddV2:(nonnull NSArray<DBTEAMMemberAddV2Arg *> *)dNewMembers
      forceAsync:(nullable NSNumber *)forceAsync;

Swift

func membersAddV2(_ dNewMembers: [DBTEAMMemberAddV2Arg], forceAsync: NSNumber?) -> DBRpcTask<DBTEAMMembersAddLaunchV2Result, DBNilObject>

Parameters


                                dNewMembers

Details of new members to be added to the team.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersAddLaunchV2Result object on success or a void object on failure.


                    
                    
                    -membersAdd:

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’.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersAddLaunch *, DBNilObject *> *)membersAdd:
    (nonnull NSArray<DBTEAMMemberAddArg *> *)dNewMembers;

Swift

func membersAdd(_ dNewMembers: [DBTEAMMemberAddArg]) -> DBRpcTask<DBTEAMMembersAddLaunch, DBNilObject>

Parameters


                                dNewMembers

Details of new members to be added to the team.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersAddLaunch object on success or a void object on failure.


                    
                    
                    -membersAdd:forceAsync:

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’.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersAddLaunch *, DBNilObject *> *)
    membersAdd:(nonnull NSArray<DBTEAMMemberAddArg *> *)dNewMembers
    forceAsync:(nullable NSNumber *)forceAsync;

Swift

func membersAdd(_ dNewMembers: [DBTEAMMemberAddArg], forceAsync: NSNumber?) -> DBRpcTask<DBTEAMMembersAddLaunch, DBNilObject>

Parameters


                                dNewMembers

Details of new members to be added to the team.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersAddLaunch object on success or a void object on failure.


                    
                    
                    -membersAddJobStatusGetV2:

Once an async_job_id is returned from membersAdd , use this to poll the status of the asynchronous request. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersAddJobStatusV2Result *, DBASYNCPollError *> *)
    membersAddJobStatusGetV2:(nonnull NSString *)asyncJobId;

Swift

func membersAddJobStatusGetV2(_ asyncJobId: String) -> DBRpcTask<DBTEAMMembersAddJobStatusV2Result, DBASYNCPollError>

Parameters


                                asyncJobId

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersAddJobStatusV2Result object on success or a DBASYNCPollError object on failure.


                    
                    
                    -membersAddJobStatusGet:

Once an async_job_id is returned from membersAdd , use this to poll the status of the asynchronous request. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersAddJobStatus *, DBASYNCPollError *> *)
    membersAddJobStatusGet:(nonnull NSString *)asyncJobId;

Swift

func membersAddJobStatusGet(_ asyncJobId: String) -> DBRpcTask<DBTEAMMembersAddJobStatus, DBASYNCPollError>

Parameters


                                asyncJobId

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersAddJobStatus object on success or a DBASYNCPollError object on failure.


                    
                    
                    -membersDeleteProfilePhotoV2:

Deletes a team member’s profile photo. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamMemberInfoV2Result *,
                     DBTEAMMembersDeleteProfilePhotoError *> *)
    membersDeleteProfilePhotoV2:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersDeleteProfilePhotoV2(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBTEAMTeamMemberInfoV2Result, DBTEAMMembersDeleteProfilePhotoError>

Parameters


                                user

Identity of the user whose profile photo will be deleted.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfoV2Result object on success or a DBTEAMMembersDeleteProfilePhotoError object on failure.


                    
                    
                    -membersDeleteProfilePhoto:

Deletes a team member’s profile photo. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamMemberInfo *,
                     DBTEAMMembersDeleteProfilePhotoError *> *)
    membersDeleteProfilePhoto:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersDeleteProfilePhoto(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBTEAMTeamMemberInfo, DBTEAMMembersDeleteProfilePhotoError>

Parameters


                                user

Identity of the user whose profile photo will be deleted.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfo object on success or a DBTEAMMembersDeleteProfilePhotoError object on failure.


                    
                    
                    -membersGetAvailableTeamMemberRoles

Get available TeamMemberRoles for the connected team. To be used with membersSetAdminPermissions. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersGetAvailableTeamMemberRolesResult *,
                     DBNilObject *> *)membersGetAvailableTeamMemberRoles;

Swift

func membersGetAvailableTeamMemberRoles() -> DBRpcTask<DBTEAMMembersGetAvailableTeamMemberRolesResult, DBNilObject>

Return Value

Through the response callback, the caller will receive a DBTEAMMembersGetAvailableTeamMemberRolesResult object on success or a void object on failure.


                    
                    
                    -membersGetInfoV2:

Returns information about multiple team members. Permission : Team information This endpoint will return idNotFound in DBTEAMMembersGetInfoItem, for IDs (or emails) that cannot be matched to a valid team member.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersGetInfoV2Result *,
                     DBTEAMMembersGetInfoError *> *)membersGetInfoV2:
    (nonnull NSArray<DBTEAMUserSelectorArg *> *)members;

Swift

func membersGetInfoV2(_ members: [DBTEAMUserSelectorArg]) -> DBRpcTask<DBTEAMMembersGetInfoV2Result, DBTEAMMembersGetInfoError>

Parameters


                                members

List of team members.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersGetInfoV2Result object on success or a DBTEAMMembersGetInfoError object on failure.


                    
                    
                    -membersGetInfo:

Returns information about multiple team members. Permission : Team information This endpoint will return idNotFound in DBTEAMMembersGetInfoItem, for IDs (or emails) that cannot be matched to a valid team member.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMMembersGetInfoItem *> *,
                     DBTEAMMembersGetInfoError *> *)membersGetInfo:
    (nonnull NSArray<DBTEAMUserSelectorArg *> *)members;

Swift

func membersGetInfo(_ members: [DBTEAMUserSelectorArg]) -> DBRpcTask<NSArray, DBTEAMMembersGetInfoError>

Parameters


                                members

List of team members.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMMembersGetInfoItem *> object on success or a DBTEAMMembersGetInfoError object on failure.


                    
                    
                    -membersListV2

Lists members of a team. Permission : Team information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersListV2Result *, DBTEAMMembersListError *> *)
    membersListV2;

Swift

func membersListV2() -> DBRpcTask<DBTEAMMembersListV2Result, DBTEAMMembersListError>

Return Value

Through the response callback, the caller will receive a DBTEAMMembersListV2Result object on success or a DBTEAMMembersListError object on failure.


                    
                    
                    -membersListV2:includeRemoved:

Lists members of a team. Permission : Team information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersListV2Result *, DBTEAMMembersListError *> *)
     membersListV2:(nullable NSNumber *)limit
    includeRemoved:(nullable NSNumber *)includeRemoved;

Swift

func membersListV2(_ limit: NSNumber?, includeRemoved: NSNumber?) -> DBRpcTask<DBTEAMMembersListV2Result, DBTEAMMembersListError>

Parameters

`limit`	Number of results to return per call.
`includeRemoved`	Whether to return removed members.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersListV2Result object on success or a DBTEAMMembersListError object on failure.


                    
                    
                    -membersList

Lists members of a team. Permission : Team information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersListResult *, DBTEAMMembersListError *> *)
    membersList;

Swift

func membersList() -> DBRpcTask<DBTEAMMembersListResult, DBTEAMMembersListError>

Return Value

Through the response callback, the caller will receive a DBTEAMMembersListResult object on success or a DBTEAMMembersListError object on failure.


                    
                    
                    -membersList:includeRemoved:

Lists members of a team. Permission : Team information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersListResult *, DBTEAMMembersListError *> *)
       membersList:(nullable NSNumber *)limit
    includeRemoved:(nullable NSNumber *)includeRemoved;

Swift

func membersList(_ limit: NSNumber?, includeRemoved: NSNumber?) -> DBRpcTask<DBTEAMMembersListResult, DBTEAMMembersListError>

Parameters

`limit`	Number of results to return per call.
`includeRemoved`	Whether to return removed members.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersListResult object on success or a DBTEAMMembersListError object on failure.


                    
                    
                    -membersListContinueV2:

Once a cursor has been retrieved from membersList, use this to paginate through all team members. Permission : Team information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersListV2Result *,
                     DBTEAMMembersListContinueError *> *)membersListContinueV2:
    (nonnull NSString *)cursor;

Swift

func membersListContinueV2(_ cursor: String) -> DBRpcTask<DBTEAMMembersListV2Result, DBTEAMMembersListContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of members.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersListV2Result object on success or a DBTEAMMembersListContinueError object on failure.


                    
                    
                    -membersListContinue:

Once a cursor has been retrieved from membersList, use this to paginate through all team members. Permission : Team information.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersListResult *,
                     DBTEAMMembersListContinueError *> *)membersListContinue:
    (nonnull NSString *)cursor;

Swift

func membersListContinue(_ cursor: String) -> DBRpcTask<DBTEAMMembersListResult, DBTEAMMembersListContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of members.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersListResult object on success or a DBTEAMMembersListContinueError object on failure.


                    
                    
                    -membersMoveFormerMemberFiles:transferDestId:transferAdminId:

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 membersMoveFormerMemberFilesJobStatusCheck. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBASYNCLaunchEmptyResult *,
                     DBTEAMMembersTransferFormerMembersFilesError *> *)
    membersMoveFormerMemberFiles:(nonnull DBTEAMUserSelectorArg *)user
                  transferDestId:(nonnull DBTEAMUserSelectorArg *)transferDestId
                 transferAdminId:
                     (nonnull DBTEAMUserSelectorArg *)transferAdminId;

Swift

func membersMoveFormerMemberFiles(_ user: DBTEAMUserSelectorArg, transferDestId: DBTEAMUserSelectorArg, transferAdminId: DBTEAMUserSelectorArg) -> DBRpcTask<DBASYNCLaunchEmptyResult, DBTEAMMembersTransferFormerMembersFilesError>

Parameters

`transferDestId`	Files from the deleted member account will be transferred to this user.
`transferAdminId`	Errors during the transfer process will be sent via email to this user.

Return Value

Through the response callback, the caller will receive a DBASYNCLaunchEmptyResult object on success or a DBTEAMMembersTransferFormerMembersFilesError object on failure.


                    
                    
                    -membersMoveFormerMemberFilesJobStatusCheck:

Once an async_job_id is returned from membersMoveFormerMemberFiles , use this to poll the status of the asynchronous request. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBASYNCPollEmptyResult *, DBASYNCPollError *> *)
    membersMoveFormerMemberFilesJobStatusCheck:(nonnull NSString *)asyncJobId;

Swift

func membersMoveFormerMemberFilesJobStatusCheck(_ asyncJobId: String) -> DBRpcTask<DBASYNCPollEmptyResult, DBASYNCPollError>

Parameters


                                asyncJobId

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Return Value

Through the response callback, the caller will receive a DBASYNCPollEmptyResult object on success or a DBASYNCPollError object on failure.


                    
                    
                    -membersRecover:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMMembersRecoverError *> *)
    membersRecover:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersRecover(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBNilObject, DBTEAMMembersRecoverError>

Parameters


                                user

Identity of user to recover.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMMembersRecoverError object on failure.


                    
                    
                    -membersRemove:

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 membersRecover for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling membersAdd while a user is still recoverable on your team will return with userAlreadyOnTeam in DBTEAMMemberAddResult. 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 membersRemoveJobStatusGet.

Declaration

Objective-C

- (nonnull DBRpcTask<DBASYNCLaunchEmptyResult *, DBTEAMMembersRemoveError *> *)
    membersRemove:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersRemove(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBASYNCLaunchEmptyResult, DBTEAMMembersRemoveError>

Return Value

Through the response callback, the caller will receive a DBASYNCLaunchEmptyResult object on success or a DBTEAMMembersRemoveError object on failure.


                    
                    
                    -membersRemove:wipeData:transferDestId:transferAdminId:keepAccount:retainTeamShares:

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 membersRecover for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling membersAdd while a user is still recoverable on your team will return with userAlreadyOnTeam in DBTEAMMemberAddResult. 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 membersRemoveJobStatusGet.

Declaration

Objective-C

- (nonnull DBRpcTask<DBASYNCLaunchEmptyResult *, DBTEAMMembersRemoveError *> *)
       membersRemove:(nonnull DBTEAMUserSelectorArg *)user
            wipeData:(nullable NSNumber *)wipeData
      transferDestId:(nullable DBTEAMUserSelectorArg *)transferDestId
     transferAdminId:(nullable DBTEAMUserSelectorArg *)transferAdminId
         keepAccount:(nullable NSNumber *)keepAccount
    retainTeamShares:(nullable NSNumber *)retainTeamShares;

Swift

func membersRemove(_ user: DBTEAMUserSelectorArg, wipeData: NSNumber?, transferDestId: DBTEAMUserSelectorArg?, transferAdminId: DBTEAMUserSelectorArg?, keepAccount: NSNumber?, retainTeamShares: NSNumber?) -> DBRpcTask<DBASYNCLaunchEmptyResult, DBTEAMMembersRemoveError>

Parameters

`transferDestId`	If provided, files from the deleted member account will be transferred to this user.
`transferAdminId`	If provided, errors during the transfer process will be sent via email to this user. If the transfer_dest_id argument was provided, then this argument must be provided as well.
`keepAccount`	Downgrade the member to a Basic account. The user will retain the email address associated with their Dropbox account and data in their account that is not restricted to team members. In order to keep the account the argument wipeData should be set to false.
`retainTeamShares`	If provided, allows removed users to keep access to Dropbox folders (not Dropbox Paper folders) already explicitly shared with them (not via a group) when they are downgraded to a Basic account. Users will not retain access to folders that do not allow external sharing. In order to keep the sharing relationships, the arguments wipeData should be set to false and keepAccount should be set to true.

Return Value

Through the response callback, the caller will receive a DBASYNCLaunchEmptyResult object on success or a DBTEAMMembersRemoveError object on failure.


                    
                    
                    -membersRemoveJobStatusGet:

Once an async_job_id is returned from membersRemove , use this to poll the status of the asynchronous request. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBASYNCPollEmptyResult *, DBASYNCPollError *> *)
    membersRemoveJobStatusGet:(nonnull NSString *)asyncJobId;

Swift

func membersRemoveJobStatusGet(_ asyncJobId: String) -> DBRpcTask<DBASYNCPollEmptyResult, DBASYNCPollError>

Parameters


                                asyncJobId

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Return Value

Through the response callback, the caller will receive a DBASYNCPollEmptyResult object on success or a DBASYNCPollError object on failure.


                    
                    
                    -membersSecondaryEmailsAdd:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMAddSecondaryEmailsResult *,
                     DBTEAMAddSecondaryEmailsError *> *)
    membersSecondaryEmailsAdd:
        (nonnull NSArray<DBTEAMUserSecondaryEmailsArg *> *)dNewSecondaryEmails;

Swift

func membersSecondaryEmailsAdd(_ dNewSecondaryEmails: [DBTEAMUserSecondaryEmailsArg]) -> DBRpcTask<DBTEAMAddSecondaryEmailsResult, DBTEAMAddSecondaryEmailsError>

Parameters


                                dNewSecondaryEmails

List of users and secondary emails to add.

Return Value

Through the response callback, the caller will receive a DBTEAMAddSecondaryEmailsResult object on success or a DBTEAMAddSecondaryEmailsError object on failure.


                    
                    
                    -membersSecondaryEmailsDelete:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMDeleteSecondaryEmailsResult *, DBNilObject *> *)
    membersSecondaryEmailsDelete:
        (nonnull NSArray<DBTEAMUserSecondaryEmailsArg *> *)emailsToDelete;

Swift

func membersSecondaryEmailsDelete(_ emailsToDelete: [DBTEAMUserSecondaryEmailsArg]) -> DBRpcTask<DBTEAMDeleteSecondaryEmailsResult, DBNilObject>

Parameters


                                emailsToDelete

List of users and their secondary emails to delete.

Return Value

Through the response callback, the caller will receive a DBTEAMDeleteSecondaryEmailsResult object on success or a void object on failure.


                    
                    
                    -membersSecondaryEmailsResendVerificationEmails:

Resend secondary email verification emails. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMResendVerificationEmailResult *, DBNilObject *> *)
    membersSecondaryEmailsResendVerificationEmails:
        (nonnull NSArray<DBTEAMUserSecondaryEmailsArg *> *)emailsToResend;

Swift

func membersSecondaryEmailsResendVerificationEmails(_ emailsToResend: [DBTEAMUserSecondaryEmailsArg]) -> DBRpcTask<DBTEAMResendVerificationEmailResult, DBNilObject>

Parameters


                                emailsToResend

List of users and secondary emails to resend verification emails to.

Return Value

Through the response callback, the caller will receive a DBTEAMResendVerificationEmailResult object on success or a void object on failure.


                    
                    
                    -membersSendWelcomeEmail:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMMembersSendWelcomeError *> *)
    membersSendWelcomeEmail:(nonnull DBTEAMUserSelectorArg *)userSelectorArg;

Swift

func membersSendWelcomeEmail(_ userSelectorArg: DBTEAMUserSelectorArg) -> DBRpcTask<DBNilObject, DBTEAMMembersSendWelcomeError>

Parameters


                                userSelectorArg

Argument for selecting a single user, either by team_member_id, external_id or email.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMMembersSendWelcomeError object on failure.


                    
                    
                    -membersSetAdminPermissionsV2:

Updates a team member’s permissions. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersSetPermissions2Result *,
                     DBTEAMMembersSetPermissions2Error *> *)
    membersSetAdminPermissionsV2:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersSetAdminPermissionsV2(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBTEAMMembersSetPermissions2Result, DBTEAMMembersSetPermissions2Error>

Parameters


                                user

Identity of user whose role will be set.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersSetPermissions2Result object on success or a DBTEAMMembersSetPermissions2Error object on failure.


                    
                    
                    -membersSetAdminPermissionsV2:dNewRoles:

Updates a team member’s permissions. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersSetPermissions2Result *,
                     DBTEAMMembersSetPermissions2Error *> *)
    membersSetAdminPermissionsV2:(nonnull DBTEAMUserSelectorArg *)user
                       dNewRoles:(nullable NSArray<NSString *> *)dNewRoles;

Swift

func membersSetAdminPermissionsV2(_ user: DBTEAMUserSelectorArg, dNewRoles: [String]?) -> DBRpcTask<DBTEAMMembersSetPermissions2Result, DBTEAMMembersSetPermissions2Error>

Parameters

`user`	Identity of user whose role will be set.
`dNewRoles`	The new roles for the member. Send empty list to make user member only. For now, only up to one role is allowed.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersSetPermissions2Result object on success or a DBTEAMMembersSetPermissions2Error object on failure.


                    
                    
                    -membersSetAdminPermissions:dNewRole:

Updates a team member’s permissions. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMMembersSetPermissionsResult *,
                     DBTEAMMembersSetPermissionsError *> *)
    membersSetAdminPermissions:(nonnull DBTEAMUserSelectorArg *)user
                      dNewRole:(nonnull DBTEAMAdminTier *)dNewRole;

Swift

func membersSetAdminPermissions(_ user: DBTEAMUserSelectorArg, dNewRole: DBTEAMAdminTier) -> DBRpcTask<DBTEAMMembersSetPermissionsResult, DBTEAMMembersSetPermissionsError>

Parameters

`user`	Identity of user whose role will be set.
`dNewRole`	The new role of the member.

Return Value

Through the response callback, the caller will receive a DBTEAMMembersSetPermissionsResult object on success or a DBTEAMMembersSetPermissionsError object on failure.


                    
                    
                    -membersSetProfileV2:

Updates a team member’s profile. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamMemberInfoV2Result *,
                     DBTEAMMembersSetProfileError *> *)membersSetProfileV2:
    (nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersSetProfileV2(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBTEAMTeamMemberInfoV2Result, DBTEAMMembersSetProfileError>

Parameters


                                user

Identity of user whose profile will be set.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfoV2Result object on success or a DBTEAMMembersSetProfileError object on failure.


                    
                    
                    -membersSetProfileV2:dNewEmail:dNewExternalId:dNewGivenName:dNewSurname:dNewPersistentId:dNewIsDirectoryRestricted:

Updates a team member’s profile. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamMemberInfoV2Result *,
                     DBTEAMMembersSetProfileError *> *)
          membersSetProfileV2:(nonnull DBTEAMUserSelectorArg *)user
                    dNewEmail:(nullable NSString *)dNewEmail
               dNewExternalId:(nullable NSString *)dNewExternalId
                dNewGivenName:(nullable NSString *)dNewGivenName
                  dNewSurname:(nullable NSString *)dNewSurname
             dNewPersistentId:(nullable NSString *)dNewPersistentId
    dNewIsDirectoryRestricted:(nullable NSNumber *)dNewIsDirectoryRestricted;

Swift

func membersSetProfileV2(_ user: DBTEAMUserSelectorArg, dNewEmail: String?, dNewExternalId: String?, dNewGivenName: String?, dNewSurname: String?, dNewPersistentId: String?, dNewIsDirectoryRestricted: NSNumber?) -> DBRpcTask<DBTEAMTeamMemberInfoV2Result, DBTEAMMembersSetProfileError>

Parameters

`user`	Identity of user whose profile will be set.
`dNewEmail`	New email for member.
`dNewExternalId`	New external ID for member.
`dNewGivenName`	New given name for member.
`dNewSurname`	New surname for member.
`dNewPersistentId`	New persistent ID. This field only available to teams using persistent ID SAML configuration.
`dNewIsDirectoryRestricted`	New value for whether the user is a directory restricted user.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfoV2Result object on success or a DBTEAMMembersSetProfileError object on failure.


                    
                    
                    -membersSetProfile:

Updates a team member’s profile. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamMemberInfo *, DBTEAMMembersSetProfileError *> *)
    membersSetProfile:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersSetProfile(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBTEAMTeamMemberInfo, DBTEAMMembersSetProfileError>

Parameters


                                user

Identity of user whose profile will be set.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfo object on success or a DBTEAMMembersSetProfileError object on failure.


                    
                    
                    -membersSetProfile:dNewEmail:dNewExternalId:dNewGivenName:dNewSurname:dNewPersistentId:dNewIsDirectoryRestricted:

Updates a team member’s profile. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamMemberInfo *, DBTEAMMembersSetProfileError *> *)
            membersSetProfile:(nonnull DBTEAMUserSelectorArg *)user
                    dNewEmail:(nullable NSString *)dNewEmail
               dNewExternalId:(nullable NSString *)dNewExternalId
                dNewGivenName:(nullable NSString *)dNewGivenName
                  dNewSurname:(nullable NSString *)dNewSurname
             dNewPersistentId:(nullable NSString *)dNewPersistentId
    dNewIsDirectoryRestricted:(nullable NSNumber *)dNewIsDirectoryRestricted;

Swift

func membersSetProfile(_ user: DBTEAMUserSelectorArg, dNewEmail: String?, dNewExternalId: String?, dNewGivenName: String?, dNewSurname: String?, dNewPersistentId: String?, dNewIsDirectoryRestricted: NSNumber?) -> DBRpcTask<DBTEAMTeamMemberInfo, DBTEAMMembersSetProfileError>

Parameters

`user`	Identity of user whose profile will be set.
`dNewEmail`	New email for member.
`dNewExternalId`	New external ID for member.
`dNewGivenName`	New given name for member.
`dNewSurname`	New surname for member.
`dNewPersistentId`	New persistent ID. This field only available to teams using persistent ID SAML configuration.
`dNewIsDirectoryRestricted`	New value for whether the user is a directory restricted user.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfo object on success or a DBTEAMMembersSetProfileError object on failure.


                    
                    
                    -membersSetProfilePhotoV2:photo:

Updates a team member’s profile photo. Permission : Team member management.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamMemberInfoV2Result *,
                     DBTEAMMembersSetProfilePhotoError *> *)
    membersSetProfilePhotoV2:(nonnull DBTEAMUserSelectorArg *)user
                       photo:(nonnull DBACCOUNTPhotoSourceArg *)photo;

Swift

func membersSetProfilePhotoV2(_ user: DBTEAMUserSelectorArg, photo: DBACCOUNTPhotoSourceArg) -> DBRpcTask<DBTEAMTeamMemberInfoV2Result, DBTEAMMembersSetProfilePhotoError>

Parameters

`user`	Identity of the user whose profile photo will be set.
`photo`	Image to set as the member’s new profile photo.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfoV2Result object on success or a DBTEAMMembersSetProfilePhotoError object on failure.


                    
                    
                    -membersSetProfilePhoto:photo:

Updates a team member’s profile photo. Permission : Team member management.

Declaration

Objective-C

- (nonnull
       DBRpcTask<DBTEAMTeamMemberInfo *, DBTEAMMembersSetProfilePhotoError *> *)
    membersSetProfilePhoto:(nonnull DBTEAMUserSelectorArg *)user
                     photo:(nonnull DBACCOUNTPhotoSourceArg *)photo;

Swift

func membersSetProfilePhoto(_ user: DBTEAMUserSelectorArg, photo: DBACCOUNTPhotoSourceArg) -> DBRpcTask<DBTEAMTeamMemberInfo, DBTEAMMembersSetProfilePhotoError>

Parameters

`user`	Identity of the user whose profile photo will be set.
`photo`	Image to set as the member’s new profile photo.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamMemberInfo object on success or a DBTEAMMembersSetProfilePhotoError object on failure.


                    
                    
                    -membersSuspend:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMMembersSuspendError *> *)
    membersSuspend:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersSuspend(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBNilObject, DBTEAMMembersSuspendError>

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMMembersSuspendError object on failure.


                    
                    
                    -membersSuspend:wipeData:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMMembersSuspendError *> *)
    membersSuspend:(nonnull DBTEAMUserSelectorArg *)user
          wipeData:(nullable NSNumber *)wipeData;

Swift

func membersSuspend(_ user: DBTEAMUserSelectorArg, wipeData: NSNumber?) -> DBRpcTask<DBNilObject, DBTEAMMembersSuspendError>

Parameters


                                wipeData

If provided, controls if the user’s data will be deleted on their linked devices.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMMembersSuspendError object on failure.


                    
                    
                    -membersUnsuspend:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMMembersUnsuspendError *> *)
    membersUnsuspend:(nonnull DBTEAMUserSelectorArg *)user;

Swift

func membersUnsuspend(_ user: DBTEAMUserSelectorArg) -> DBRpcTask<DBNilObject, DBTEAMMembersUnsuspendError>

Parameters


                                user

Identity of user to unsuspend.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMMembersUnsuspendError object on failure.


                    
                    
                    -namespacesList

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamNamespacesListResult *,
                     DBTEAMTeamNamespacesListError *> *)namespacesList;

Swift

func namespacesList() -> DBRpcTask<DBTEAMTeamNamespacesListResult, DBTEAMTeamNamespacesListError>

Return Value

Through the response callback, the caller will receive a DBTEAMTeamNamespacesListResult object on success or a DBTEAMTeamNamespacesListError object on failure.


                    
                    
                    -namespacesList:

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.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamNamespacesListResult *,
                     DBTEAMTeamNamespacesListError *> *)namespacesList:
    (nullable NSNumber *)limit;

Swift

func namespacesList(_ limit: NSNumber?) -> DBRpcTask<DBTEAMTeamNamespacesListResult, DBTEAMTeamNamespacesListError>

Parameters


                                limit

Specifying a value here has no effect.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamNamespacesListResult object on success or a DBTEAMTeamNamespacesListError object on failure.


                    
                    
                    -namespacesListContinue:

Once a cursor has been retrieved from namespacesList, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamNamespacesListResult *,
                     DBTEAMTeamNamespacesListContinueError *> *)
    namespacesListContinue:(nonnull NSString *)cursor;

Swift

func namespacesListContinue(_ cursor: String) -> DBRpcTask<DBTEAMTeamNamespacesListResult, DBTEAMTeamNamespacesListContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of team-accessible namespaces.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamNamespacesListResult object on success or a DBTEAMTeamNamespacesListContinueError object on failure.


                    
                    
                    -propertiesTemplateAdd:description_:fields:

Deprecated

propertiesTemplateAdd is deprecated.

DEPRECATED: Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBFILEPROPERTIESAddTemplateResult *,
                     DBFILEPROPERTIESModifyTemplateError *> *)
    propertiesTemplateAdd:(nonnull NSString *)name
             description_:(nonnull NSString *)description_
                   fields:
                       (nonnull NSArray<DBFILEPROPERTIESPropertyFieldTemplate *>
                            *)fields;

Swift

func propertiesTemplateAdd(_ name: String, description_: String, fields: [DBFILEPROPERTIESPropertyFieldTemplate]) -> DBRpcTask<DBFILEPROPERTIESAddTemplateResult, DBFILEPROPERTIESModifyTemplateError>

Return Value

Through the response callback, the caller will receive a DBFILEPROPERTIESAddTemplateResult object on success or a DBFILEPROPERTIESModifyTemplateError object on failure.


                    
                    
                    -propertiesTemplateGet:

Deprecated

propertiesTemplateGet is deprecated.

DEPRECATED: Permission : Team member file access. The scope for the route is files.team_metadata.write.

Declaration

Objective-C

- (nonnull DBRpcTask<DBFILEPROPERTIESGetTemplateResult *,
                     DBFILEPROPERTIESTemplateError *> *)propertiesTemplateGet:
    (nonnull NSString *)templateId;

Swift

func propertiesTemplateGet(_ templateId: String) -> DBRpcTask<DBFILEPROPERTIESGetTemplateResult, DBFILEPROPERTIESTemplateError>

Parameters


                                templateId

An identifier for template added by route See templatesAddForUser or templatesAddForTeam.

Return Value

Through the response callback, the caller will receive a DBFILEPROPERTIESGetTemplateResult object on success or a DBFILEPROPERTIESTemplateError object on failure.


                    
                    
                    -propertiesTemplateList

Deprecated

propertiesTemplateList is deprecated.

DEPRECATED: Permission : Team member file access. The scope for the route is files.team_metadata.write.

Declaration

Objective-C

- (nonnull DBRpcTask<DBFILEPROPERTIESListTemplateResult *,
                     DBFILEPROPERTIESTemplateError *> *)propertiesTemplateList;

Swift

func propertiesTemplateList() -> DBRpcTask<DBFILEPROPERTIESListTemplateResult, DBFILEPROPERTIESTemplateError>

Return Value

Through the response callback, the caller will receive a DBFILEPROPERTIESListTemplateResult object on success or a DBFILEPROPERTIESTemplateError object on failure.


                    
                    
                    -propertiesTemplateUpdate:

Deprecated

propertiesTemplateUpdate is deprecated.

DEPRECATED: Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBFILEPROPERTIESUpdateTemplateResult *,
                     DBFILEPROPERTIESModifyTemplateError *> *)
    propertiesTemplateUpdate:(nonnull NSString *)templateId;

Swift

func propertiesTemplateUpdate(_ templateId: String) -> DBRpcTask<DBFILEPROPERTIESUpdateTemplateResult, DBFILEPROPERTIESModifyTemplateError>

Parameters


                                templateId

An identifier for template added by See templatesAddForUser or templatesAddForTeam.

Return Value

Through the response callback, the caller will receive a DBFILEPROPERTIESUpdateTemplateResult object on success or a DBFILEPROPERTIESModifyTemplateError object on failure.


                    
                    
                    -propertiesTemplateUpdate:name:description_:addFields:

Deprecated

propertiesTemplateUpdate is deprecated.

DEPRECATED: Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBFILEPROPERTIESUpdateTemplateResult *,
                     DBFILEPROPERTIESModifyTemplateError *> *)
    propertiesTemplateUpdate:(nonnull NSString *)templateId
                        name:(nullable NSString *)name
                description_:(nullable NSString *)description_
                   addFields:
                       (nullable
                            NSArray<DBFILEPROPERTIESPropertyFieldTemplate *> *)
                           addFields;

Swift

func propertiesTemplateUpdate(_ templateId: String, name: String?, description_: String?, addFields: [DBFILEPROPERTIESPropertyFieldTemplate]?) -> DBRpcTask<DBFILEPROPERTIESUpdateTemplateResult, DBFILEPROPERTIESModifyTemplateError>

Parameters

`templateId`	An identifier for template added by See `templatesAddForUser` or `templatesAddForTeam`.
`name`	A display name for the template. template names can be up to 256 bytes.
`description_`	Description for the new template. Template descriptions can be up to 1024 bytes.
`addFields`	Property field templates to be added to the group template. There can be up to 32 properties in a single template.

Return Value

Through the response callback, the caller will receive a DBFILEPROPERTIESUpdateTemplateResult object on success or a DBFILEPROPERTIESModifyTemplateError object on failure.


                    
                    
                    -reportsGetActivity

Deprecated

reportsGetActivity is deprecated.

DEPRECATED: Retrieves reporting data about a team’s user activity. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetActivityReport *, DBTEAMDateRangeError *> *)
    reportsGetActivity;

Swift

func reportsGetActivity() -> DBRpcTask<DBTEAMGetActivityReport, DBTEAMDateRangeError>

Return Value

Through the response callback, the caller will receive a DBTEAMGetActivityReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -reportsGetActivity:endDate:

Deprecated

reportsGetActivity is deprecated.

DEPRECATED: Retrieves reporting data about a team’s user activity. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetActivityReport *, DBTEAMDateRangeError *> *)
    reportsGetActivity:(nullable NSDate *)startDate
               endDate:(nullable NSDate *)endDate;

Swift

func reportsGetActivity(_ startDate: Date?, end endDate: Date?) -> DBRpcTask<DBTEAMGetActivityReport, DBTEAMDateRangeError>

Parameters

`startDate`	Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago.
`endDate`	Optional ending date (exclusive).

Return Value

Through the response callback, the caller will receive a DBTEAMGetActivityReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -reportsGetDevices

Deprecated

reportsGetDevices is deprecated.

DEPRECATED: Retrieves reporting data about a team’s linked devices. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetDevicesReport *, DBTEAMDateRangeError *> *)
    reportsGetDevices;

Swift

func reportsGetDevices() -> DBRpcTask<DBTEAMGetDevicesReport, DBTEAMDateRangeError>

Return Value

Through the response callback, the caller will receive a DBTEAMGetDevicesReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -reportsGetDevices:endDate:

Deprecated

reportsGetDevices is deprecated.

DEPRECATED: Retrieves reporting data about a team’s linked devices. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetDevicesReport *, DBTEAMDateRangeError *> *)
    reportsGetDevices:(nullable NSDate *)startDate
              endDate:(nullable NSDate *)endDate;

Swift

func reportsGetDevices(_ startDate: Date?, end endDate: Date?) -> DBRpcTask<DBTEAMGetDevicesReport, DBTEAMDateRangeError>

Parameters

`startDate`	Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago.
`endDate`	Optional ending date (exclusive).

Return Value

Through the response callback, the caller will receive a DBTEAMGetDevicesReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -reportsGetMembership

Deprecated

reportsGetMembership is deprecated.

DEPRECATED: Retrieves reporting data about a team’s membership. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetMembershipReport *, DBTEAMDateRangeError *> *)
    reportsGetMembership;

Swift

func reportsGetMembership() -> DBRpcTask<DBTEAMGetMembershipReport, DBTEAMDateRangeError>

Return Value

Through the response callback, the caller will receive a DBTEAMGetMembershipReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -reportsGetMembership:endDate:

Deprecated

reportsGetMembership is deprecated.

DEPRECATED: Retrieves reporting data about a team’s membership. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetMembershipReport *, DBTEAMDateRangeError *> *)
    reportsGetMembership:(nullable NSDate *)startDate
                 endDate:(nullable NSDate *)endDate;

Swift

func reportsGetMembership(_ startDate: Date?, end endDate: Date?) -> DBRpcTask<DBTEAMGetMembershipReport, DBTEAMDateRangeError>

Parameters

`startDate`	Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago.
`endDate`	Optional ending date (exclusive).

Return Value

Through the response callback, the caller will receive a DBTEAMGetMembershipReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -reportsGetStorage

Deprecated

reportsGetStorage is deprecated.

DEPRECATED: Retrieves reporting data about a team’s storage usage. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetStorageReport *, DBTEAMDateRangeError *> *)
    reportsGetStorage;

Swift

func reportsGetStorage() -> DBRpcTask<DBTEAMGetStorageReport, DBTEAMDateRangeError>

Return Value

Through the response callback, the caller will receive a DBTEAMGetStorageReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -reportsGetStorage:endDate:

Deprecated

reportsGetStorage is deprecated.

DEPRECATED: Retrieves reporting data about a team’s storage usage. Deprecated: Will be removed on July 1st 2021.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMGetStorageReport *, DBTEAMDateRangeError *> *)
    reportsGetStorage:(nullable NSDate *)startDate
              endDate:(nullable NSDate *)endDate;

Swift

func reportsGetStorage(_ startDate: Date?, end endDate: Date?) -> DBRpcTask<DBTEAMGetStorageReport, DBTEAMDateRangeError>

Parameters

`startDate`	Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago.
`endDate`	Optional ending date (exclusive).

Return Value

Through the response callback, the caller will receive a DBTEAMGetStorageReport object on success or a DBTEAMDateRangeError object on failure.


                    
                    
                    -sharingAllowlistAdd

Endpoint adds Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Added entries cannot overflow limit of 10000 entries per team. Maximum 100 entries per call is allowed.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMSharingAllowlistAddResponse *,
                     DBTEAMSharingAllowlistAddError *> *)sharingAllowlistAdd;

Swift

func sharingAllowlistAdd() -> DBRpcTask<DBTEAMSharingAllowlistAddResponse, DBTEAMSharingAllowlistAddError>

Return Value

Through the response callback, the caller will receive a DBTEAMSharingAllowlistAddResponse object on success or a DBTEAMSharingAllowlistAddError object on failure.


                    
                    
                    -sharingAllowlistAdd:emails:

Endpoint adds Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Added entries cannot overflow limit of 10000 entries per team. Maximum 100 entries per call is allowed.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMSharingAllowlistAddResponse *,
                     DBTEAMSharingAllowlistAddError *> *)
    sharingAllowlistAdd:(nullable NSArray<NSString *> *)domains
                 emails:(nullable NSArray<NSString *> *)emails;

Swift

func sharingAllowlistAdd(_ domains: [String]?, emails: [String]?) -> DBRpcTask<DBTEAMSharingAllowlistAddResponse, DBTEAMSharingAllowlistAddError>

Parameters

`domains`	List of domains represented by valid string representation (RFC-1034/5).
`emails`	List of emails represented by valid string representation (RFC-5322/822).

Return Value

Through the response callback, the caller will receive a DBTEAMSharingAllowlistAddResponse object on success or a DBTEAMSharingAllowlistAddError object on failure.


                    
                    
                    -sharingAllowlistList

Lists Approve List entries for given team, from newest to oldest, returning up to limit entries at a time. If there are more than limit entries associated with the current team, more can be fetched by passing the returned cursor to sharingAllowlistListContinue.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMSharingAllowlistListResponse *,
                     DBTEAMSharingAllowlistListError *> *)sharingAllowlistList;

Swift

func sharingAllowlistList() -> DBRpcTask<DBTEAMSharingAllowlistListResponse, DBTEAMSharingAllowlistListError>

Return Value

Through the response callback, the caller will receive a DBTEAMSharingAllowlistListResponse object on success or a DBTEAMSharingAllowlistListError object on failure.


                    
                    
                    -sharingAllowlistList:

Lists Approve List entries for given team, from newest to oldest, returning up to limit entries at a time. If there are more than limit entries associated with the current team, more can be fetched by passing the returned cursor to sharingAllowlistListContinue.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMSharingAllowlistListResponse *,
                     DBTEAMSharingAllowlistListError *> *)sharingAllowlistList:
    (nullable NSNumber *)limit;

Swift

func sharingAllowlistList(_ limit: NSNumber?) -> DBRpcTask<DBTEAMSharingAllowlistListResponse, DBTEAMSharingAllowlistListError>

Parameters


                                limit

The number of entries to fetch at one time.

Return Value

Through the response callback, the caller will receive a DBTEAMSharingAllowlistListResponse object on success or a DBTEAMSharingAllowlistListError object on failure.


                    
                    
                    -sharingAllowlistListContinue:

Lists entries associated with given team, starting from a the cursor. See sharingAllowlistList.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMSharingAllowlistListResponse *,
                     DBTEAMSharingAllowlistListContinueError *> *)
    sharingAllowlistListContinue:(nonnull NSString *)cursor;

Swift

func sharingAllowlistListContinue(_ cursor: String) -> DBRpcTask<DBTEAMSharingAllowlistListResponse, DBTEAMSharingAllowlistListContinueError>

Parameters


                                cursor

The cursor returned from a previous call to sharingAllowlistList or sharingAllowlistListContinue.

Return Value

Through the response callback, the caller will receive a DBTEAMSharingAllowlistListResponse object on success or a DBTEAMSharingAllowlistListContinueError object on failure.


                    
                    
                    -sharingAllowlistRemove

Endpoint removes Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Entries being removed have to be present on the list. Maximum 1000 entries per call is allowed.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMSharingAllowlistRemoveResponse *,
                     DBTEAMSharingAllowlistRemoveError *> *)
    sharingAllowlistRemove;

Swift

func sharingAllowlistRemove() -> DBRpcTask<DBTEAMSharingAllowlistRemoveResponse, DBTEAMSharingAllowlistRemoveError>

Return Value

Through the response callback, the caller will receive a DBTEAMSharingAllowlistRemoveResponse object on success or a DBTEAMSharingAllowlistRemoveError object on failure.


                    
                    
                    -sharingAllowlistRemove:emails:

Endpoint removes Approve List entries. Changes are effective immediately. Changes are committed in transaction. In case of single validation error - all entries are rejected. Valid domains (RFC-1034/5) and emails (RFC-5322/822) are accepted. Entries being removed have to be present on the list. Maximum 1000 entries per call is allowed.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMSharingAllowlistRemoveResponse *,
                     DBTEAMSharingAllowlistRemoveError *> *)
    sharingAllowlistRemove:(nullable NSArray<NSString *> *)domains
                    emails:(nullable NSArray<NSString *> *)emails;

Swift

func sharingAllowlistRemove(_ domains: [String]?, emails: [String]?) -> DBRpcTask<DBTEAMSharingAllowlistRemoveResponse, DBTEAMSharingAllowlistRemoveError>

Parameters

`domains`	List of domains represented by valid string representation (RFC-1034/5).
`emails`	List of emails represented by valid string representation (RFC-5322/822).

Return Value

Through the response callback, the caller will receive a DBTEAMSharingAllowlistRemoveResponse object on success or a DBTEAMSharingAllowlistRemoveError object on failure.


                    
                    
                    -teamFolderActivate:

Sets an archived team folder’s status to active. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderMetadata *,
                     DBTEAMTeamFolderActivateError *> *)teamFolderActivate:
    (nonnull NSString *)teamFolderId;

Swift

func teamFolderActivate(_ teamFolderId: String) -> DBRpcTask<DBTEAMTeamFolderMetadata, DBTEAMTeamFolderActivateError>

Parameters


                                teamFolderId

The ID of the team folder.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderMetadata object on success or a DBTEAMTeamFolderActivateError object on failure.


                    
                    
                    -teamFolderArchive:

Sets an active team folder’s status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderArchiveLaunch *,
                     DBTEAMTeamFolderArchiveError *> *)teamFolderArchive:
    (nonnull NSString *)teamFolderId;

Swift

func teamFolderArchive(_ teamFolderId: String) -> DBRpcTask<DBTEAMTeamFolderArchiveLaunch, DBTEAMTeamFolderArchiveError>

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderArchiveLaunch object on success or a DBTEAMTeamFolderArchiveError object on failure.


                    
                    
                    -teamFolderArchive:forceAsyncOff:

Sets an active team folder’s status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderArchiveLaunch *,
                     DBTEAMTeamFolderArchiveError *> *)
    teamFolderArchive:(nonnull NSString *)teamFolderId
        forceAsyncOff:(nullable NSNumber *)forceAsyncOff;

Swift

func teamFolderArchive(_ teamFolderId: String, forceAsyncOff: NSNumber?) -> DBRpcTask<DBTEAMTeamFolderArchiveLaunch, DBTEAMTeamFolderArchiveError>

Parameters


                                forceAsyncOff

Whether to force the archive to happen synchronously.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderArchiveLaunch object on success or a DBTEAMTeamFolderArchiveError object on failure.


                    
                    
                    -teamFolderArchiveCheck:

Returns the status of an asynchronous job for archiving a team folder. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderArchiveJobStatus *, DBASYNCPollError *> *)
    teamFolderArchiveCheck:(nonnull NSString *)asyncJobId;

Swift

func teamFolderArchiveCheck(_ asyncJobId: String) -> DBRpcTask<DBTEAMTeamFolderArchiveJobStatus, DBASYNCPollError>

Parameters


                                asyncJobId

Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderArchiveJobStatus object on success or a DBASYNCPollError object on failure.


                    
                    
                    -teamFolderCreate:

Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderMetadata *, DBTEAMTeamFolderCreateError *>
       *)teamFolderCreate:(nonnull NSString *)name;

Swift

func teamFolderCreate(_ name: String) -> DBRpcTask<DBTEAMTeamFolderMetadata, DBTEAMTeamFolderCreateError>

Parameters


                                name

Name for the new team folder.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderMetadata object on success or a DBTEAMTeamFolderCreateError object on failure.


                    
                    
                    -teamFolderCreate:syncSetting:

Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderMetadata *, DBTEAMTeamFolderCreateError *>
       *)teamFolderCreate:(nonnull NSString *)name
              syncSetting:(nullable DBFILESSyncSettingArg *)syncSetting;

Swift

func teamFolderCreate(_ name: String, syncSetting: DBFILESSyncSettingArg?) -> DBRpcTask<DBTEAMTeamFolderMetadata, DBTEAMTeamFolderCreateError>

Parameters

`name`	Name for the new team folder.
`syncSetting`	The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderMetadata object on success or a DBTEAMTeamFolderCreateError object on failure.


                    
                    
                    -teamFolderGetInfo:

Retrieves metadata for team folders. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<NSArray<DBTEAMTeamFolderGetInfoItem *> *, DBNilObject *> *)
    teamFolderGetInfo:(nonnull NSArray<NSString *> *)teamFolderIds;

Swift

func teamFolderGetInfo(_ teamFolderIds: [String]) -> DBRpcTask<NSArray, DBNilObject>

Parameters


                                teamFolderIds

The list of team folder IDs.

Return Value

Through the response callback, the caller will receive a NSArray<DBTEAMTeamFolderGetInfoItem *> object on success or a void object on failure.


                    
                    
                    -teamFolderList

Lists all team folders. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderListResult *, DBTEAMTeamFolderListError *>
       *)teamFolderList;

Swift

func teamFolderList() -> DBRpcTask<DBTEAMTeamFolderListResult, DBTEAMTeamFolderListError>

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderListResult object on success or a DBTEAMTeamFolderListError object on failure.


                    
                    
                    -teamFolderList:

Lists all team folders. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderListResult *, DBTEAMTeamFolderListError *>
       *)teamFolderList:(nullable NSNumber *)limit;

Swift

func teamFolderList(_ limit: NSNumber?) -> DBRpcTask<DBTEAMTeamFolderListResult, DBTEAMTeamFolderListError>

Parameters


                                limit

The maximum number of results to return per request.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderListResult object on success or a DBTEAMTeamFolderListError object on failure.


                    
                    
                    -teamFolderListContinue:

Once a cursor has been retrieved from teamFolderList, use this to paginate through all team folders. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderListResult *,
                     DBTEAMTeamFolderListContinueError *> *)
    teamFolderListContinue:(nonnull NSString *)cursor;

Swift

func teamFolderListContinue(_ cursor: String) -> DBRpcTask<DBTEAMTeamFolderListResult, DBTEAMTeamFolderListContinueError>

Parameters


                                cursor

Indicates from what point to get the next set of team folders.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderListResult object on success or a DBTEAMTeamFolderListContinueError object on failure.


                    
                    
                    -teamFolderPermanentlyDelete:

Permanently deletes an archived team folder. This endpoint cannot be used for teams that have a shared team space. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBNilObject *, DBTEAMTeamFolderPermanentlyDeleteError *> *)
    teamFolderPermanentlyDelete:(nonnull NSString *)teamFolderId;

Swift

func teamFolderPermanentlyDelete(_ teamFolderId: String) -> DBRpcTask<DBNilObject, DBTEAMTeamFolderPermanentlyDeleteError>

Parameters


                                teamFolderId

The ID of the team folder.

Return Value

Through the response callback, the caller will receive a void object on success or a DBTEAMTeamFolderPermanentlyDeleteError object on failure.


                    
                    
                    -teamFolderRename:name:

Changes an active team folder’s name. Permission : Team member file access.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderMetadata *, DBTEAMTeamFolderRenameError *>
       *)teamFolderRename:(nonnull NSString *)teamFolderId
                     name:(nonnull NSString *)name;

Swift

func teamFolderRename(_ teamFolderId: String, name: String) -> DBRpcTask<DBTEAMTeamFolderMetadata, DBTEAMTeamFolderRenameError>

Parameters


                                name

New team folder name.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderMetadata object on success or a DBTEAMTeamFolderRenameError object on failure.


                    
                    
                    -teamFolderUpdateSyncSettings:

Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderMetadata *,
                     DBTEAMTeamFolderUpdateSyncSettingsError *> *)
    teamFolderUpdateSyncSettings:(nonnull NSString *)teamFolderId;

Swift

func teamFolderUpdateSyncSettings(_ teamFolderId: String) -> DBRpcTask<DBTEAMTeamFolderMetadata, DBTEAMTeamFolderUpdateSyncSettingsError>

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderMetadata object on success or a DBTEAMTeamFolderUpdateSyncSettingsError object on failure.


                    
                    
                    -teamFolderUpdateSyncSettings:syncSetting:contentSyncSettings:

Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTeamFolderMetadata *,
                     DBTEAMTeamFolderUpdateSyncSettingsError *> *)
    teamFolderUpdateSyncSettings:(nonnull NSString *)teamFolderId
                     syncSetting:(nullable DBFILESSyncSettingArg *)syncSetting
             contentSyncSettings:
                 (nullable NSArray<DBFILESContentSyncSettingArg *> *)
                     contentSyncSettings;

Swift

func teamFolderUpdateSyncSettings(_ teamFolderId: String, syncSetting: DBFILESSyncSettingArg?, contentSyncSettings: [DBFILESContentSyncSettingArg]?) -> DBRpcTask<DBTEAMTeamFolderMetadata, DBTEAMTeamFolderUpdateSyncSettingsError>

Parameters

`syncSetting`	Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root.
`contentSyncSettings`	Sync settings to apply to contents of this team folder.

Return Value

Through the response callback, the caller will receive a DBTEAMTeamFolderMetadata object on success or a DBTEAMTeamFolderUpdateSyncSettingsError object on failure.


                    
                    
                    -tokenGetAuthenticatedAdmin

Returns the member profile of the admin who generated the team access token used to make the call.

Declaration

Objective-C

- (nonnull DBRpcTask<DBTEAMTokenGetAuthenticatedAdminResult *,
                     DBTEAMTokenGetAuthenticatedAdminError *> *)
    tokenGetAuthenticatedAdmin;

Swift

func tokenGetAuthenticatedAdmin() -> DBRpcTask<DBTEAMTokenGetAuthenticatedAdminResult, DBTEAMTokenGetAuthenticatedAdminError>

Return Value

Through the response callback, the caller will receive a DBTEAMTokenGetAuthenticatedAdminResult object on success or a DBTEAMTokenGetAuthenticatedAdminError object on failure.