OnboardingService class

Service to handle onboarding flow

Constructors

OnboardingService.getInstance()

factory

Properties

appNamespace → String?

no setter

atClientPreference → AtClientPreference

no setter

atClientServiceMap ↔ Map<String?, AtClientService>

getter/setter pair

atStatusImpl ↔ AtStatusImpl

getter/setter pair

currentAtsign → String?

no setter

fistTimeAuthScreen ↔ Widget?

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

isPkam → bool?

no setter

keyChainManager ↔ KeyChainManager

getter/setter pair

logo → Widget?

no setter

namespace ← String

no getter

nextScreen → Widget?

no setter

onboardFunc ↔ Function

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serverStatus ↔ ServerStatus?

getter/setter pair

setAtClientPreference ← AtClientPreference

no getter

setAtsign ← String?

no getter

setLogo ← Widget?

no getter

setNextScreen ← Widget?

no getter

Methods

authenticate(String? atsign, {String? cramSecret, String? jsonData, String? decryptKey, OnboardingStatus? status}) → Future<AtOnboardingResponseStatus>

Returns false if fails in authenticating atsign with cramSecret/privateKey. Throws Exception if atsign is null.

changePrimaryAtsign({required String atsign}) → Future<bool>

Function to make the atsign passed as primary

checkAtSignServerStatus(String atsign) → Future<ServerStatus?>

checkAtsignStatus({String? atsign}) → Future<AtSignStatus?>

Returns the status of an atsign

disableUsingSharedStorage() → Future<bool>

disables sharing onboarded atSign with multiple atApps

enableUsingSharedStorage() → Future<bool>

enables sharing onboarded atSign with multiple atApps it is only supported for macOS, windows platforms.

enroll(String atSign, EnrollmentRequest enrollmentRequest) → Future<AtEnrollmentResponse>

To register for a new enrollment request

formatAtSign(String? atsign) → String?

Returns null if atsign is null else the formatted atsign. atsign must be non-null.

getAESKey(String atsign) → Future<String?>

Fetches AESkey for atsign from device keychain.

getAtSign() → Future<String?>

Fetches atsign from device keychain.

getAtsignList() → Future<List<String>>

returns the list of all onboarded atsigns

getEncryptedKeys(String atsign) → Future<Map<String, String?>>

Fetches encryption keys for atsign from device keychain.

getPrivateKey(String atsign) → Future<String?>

Fetches privatekey for atsign from device keychain.

getPublicKey(String atsign) → Future<String?>

Fetches publickey for atsign from device keychain.

initialSetup({required bool usingSharedStorage}) → Future<void>

Call this function before start onboarding

isExistingAtsign(String? atsign) → Future<bool>

isUsingSharedStorage() → Future<bool?>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onboard({String? cramSecret, AtOnboardingRequest? atOnboardingRequest}) → Future<bool>

Returns true if authentication is successful for the existing atsign in device.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited