Logout¶
Description¶
The Logout operation terminates user session and disassociates the AuthenticatedUser role from the subsequent requests made by the client application.
Method¶
Future<void> Backendless.userService.logout();
Return Value¶
None.
Example¶
The example below terminates the user session.
// do not forget to call Backendless.initApp in the app initialization code
Backendless.userService.login(username, password).then((user) {
// user has been logged in
// now, let's logout
Backendless.userService.logout().then((response) {
// user has been logged out.
});
});
Errors¶
The following errors may occur during the Logout API call. See the Error Handling section for details on how to retrieve the error code when the server returns an error.
| Error Code |
Description |
|---|---|
| 2002 |
Version is disabled or provided wrong application info (application id or secret key) |
| 3007 |
Invalid application-id or version. |
| 3023 |
General error while executing logout. Error details should be available in the message property. |
Codeless Reference¶
This operation does not return a value.
Consider the following record in the Users data table:
The example below logs in as "alice@wonderland.com", retrieves the user token, and terminates the current session by invoking the Logout operation. The user token is required for successful Logout operation.
