clearPersistedSession

Function Signature

Future<void> clearPersistedSession()

Description

A PortalAuth method. Deletes the persisted session for the configured auth environment, so a later restoreSession returns null, and forgets the grant handleRedirect last exchanged. This is not a sign-out on its own: an initialized Portal that already holds the session keeps working. To sign a user out, call Portal().clearSession(), then this method. Available starting from portal_flutter 2.0.0.

Parameters

This method takes no parameters.

Returns

Future<void> - Completes once the stored session is deleted.

Example

import 'package:portal_flutter/portal_flutter.dart';

Future<void> signOut() async {
  try {
    await Portal().clearSession();
  } on PortalException catch (e) {
    print('clearSession failed: ${e.message}');
  }

  // Runs even when clearSession() failed.
  await PortalAuth().clearPersistedSession();
}

Errors

Code	Description
`AUTH_NOT_CONFIGURED`	Called before `configure`
`AUTH_SESSION_STORAGE_FAILURE`	Secure storage failed this time. It may succeed on the next attempt
`AUTH_CLEAR_PERSISTED_SESSION_ERROR`	Any other failure

Getting Started

SDKs

APIs

Integrations

Resources

clearPersistedSession

Function Signature

Description

Parameters

Returns

Example

Errors

​Function Signature

​Description

​Parameters

​Returns

​Example

​Errors

​Related

Function Signature

Description

Parameters

Returns

Example

Errors

Related