restoreSession

Function Signature

Future<PortalSession?> restoreSession()

Description

A PortalAuth method. Returns the session persisted on this device for the configured auth environment, so a returning user does not sign in again. It makes no network call, so a session that has expired is only discovered on its first use, through onSessionInvalidated. null means “not signed in”, including a stored session the SDK can never read again, which it clears for you. On iOS, Keychain items survive app deletion, so a reinstalled app can find the previous install’s session. See Start a fresh iOS install from a clean slate. Available starting from portal_flutter 2.0.0.

Parameters

This method takes no parameters.

Returns

PortalSession? - The persisted session, or null when there is none. Pass it to Portal().initialize(session:).

Example

import 'package:portal_flutter/portal_flutter.dart';

final session = await PortalAuth().restoreSession();

if (session == null) {
  showSignIn();
} else {
  await Portal().initialize(session: session, rpcConfig: { /* ... */ });
}

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_RESTORE_SESSION_ERROR`	Any other failure

Getting Started

SDKs

APIs

Integrations

Resources

restoreSession

Function Signature

Description

Parameters

Returns

Example

Errors

​Function Signature

​Description

​Parameters

​Returns

​Example

​Errors

​Related

Function Signature

Description

Parameters

Returns

Example

Errors

Related