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<Object> callback )

public void Backendless.UserService.LogoutAsync();

Blocking API

public void Backendless.UserService.Logout();

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 

AsyncCallback<Object> logoutCallback = new AsyncCallback<Object>(
  user =>
  {
    System.Console.WriteLine( "User has been logged out" );
  },
  fault =>
  {
    System.Console.WriteLine( fault.ToString() );
  } );

Backendless.UserService.Logout( logoutCallback );



//// Another example of logging out 

await Backendless.UserService.LogoutAsync();

Blocking API

Backendless.UserService.Logout();

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.