Contents

DeleteUserCommand.Command

The command to delete a user’s account from a device.

Declaration

object DeleteUserCommand.Command

Properties

NameTypeDescription
DeleteAllUsersboolean

If true, the system attempts to delete all users from the device. If ForceDeletion is false, the system generates an error instead and doesn’t delete users who have data that’s pending sync. This value is available in iOS 14 and later.

ForceDeletionboolean

If true, the system deletes the account even if the user has data that’s pending sync to the cloud. This value is available on iOS 9.3 and later.

RequestRequiresNetworkTetherboolean

If true, the device needs to be network-tethered to run the command.

RequestType Requiredstring

The request type for this command.

UserNamestring

The user name of the account to delete. This key is required when the value for DeleteAllUsers is absent or false.