DeleteClient Method

Deletes a client from the user list.

Syntax

sharefile.deleteClient(userId, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Deletes a client from the user list. Must call ListUsers before the User* properties will be updated. UserId is the id for the user that is going to be deleted.

// Deletes the first user.
shareFile.ListUsers();
string UserId = shareFile.Users[0].Id;
shareFile.DeleteClient(UserId);