Logout¶

Description¶

The Logout operation terminates user session and disassociates the AuthenticatedUser role from the subsequent requests made by the client application.

Method¶

Non-Blocking API

public void Backendless.UserService.logout( AsyncCallback<Void> callback )

Blocking API

public void Backendless.UserService.logout() throws BackendlessException;

where:

Argument	Description
`callback`	A callback object which will receive a callback when the method successfully returns a result or an error. Applies to the non-blocking methods only.

Return Value¶

None.

Example¶

The example below terminates the user session.

Non-Blocking API

// do not forget to call Backendless.initApp in the app initialization code

Backendless.UserService.login( username, password, new AsyncCallback<BackendlessUser>()
{
 public void handleResponse( BackendlessUser user )
  {
    // user has been logged in
    // now, let's logout
    Backendless.UserService.logout( new AsyncCallback<Void>() 
    {
      public void handleResponse( Void response )
      {
        // user has been logged out.
      }

      public void handleFault( BackendlessFault fault )
      {
        // something went wrong and logout failed, to get the error code call fault.getCode()
      }
    }); 
  }

  public void handleFault( BackendlessFault fault )
  {
    // login failed, to get the error code call fault.getCode()
  }
});

Blocking API

// do not forget to call Backendless.initApp in the app initialization code

BackendlessUser user;

try
{
  user = Backendless.UserService.login( username, password );
}
catch( BackendlessException exception )
{
  // login failed, to get the error code, call exception.getFault().getCode()
}

try
{
  // now log out:
  Backendless.UserService.logout();
}
catch( BackendlessException exception )
{
  // logout failed, to get the error code, call exception.getFault().getCode()
}

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¶

user_service_codeless_logout_current_user

This operation does not return a value.

Consider the following record in the Users data table:
user_service_codeless_example_get_user_roles_example_1

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.

user_service_codeless_example_logout_current_user