Onboarding class

Constructors

Onboarding({Key? key, required BuildContext context, bool? hideReferences, bool? hideQrScan, String? atsign, required dynamic onboard(Map<String?, AtClientService>, String?), required dynamic onError(Object?), Widget? nextScreen, Widget? fistTimeAuthNextScreen, required AtClientPreference atClientPreference, Color? appColor, Widget? logo, String? domain, required RootEnvironment rootEnvironment, String? appAPIKey})

Properties

appAPIKey → String?

API authentication key for getting free atsigns

final

appColor → Color?

The color of the screen to match with the app's aesthetics. default it is black.

final

atClientPreference → AtClientPreference

The atClientPreference required to continue with the onboarding.

final

atsign → String?

Onboards the given atsign if not null. if atsign is null then takes the atsign from keychain. ifatsign is empty then it directly jumps into authenticate without performing onboarding. (or) if atsign is empty then it just presents pairAtSign screen without onboarding the atsign. (or) Just provide an empty string for ignoring existing atsign in keychain or app's atsign.

final

context → BuildContext

Required field as for navigation.

final

domain → String?

Default the plugin connects to root.atsign.org to perform onboarding.

final

fistTimeAuthNextScreen → Widget?

after first time succesful onboarding it will get redirected to this screen if not null.

final

hashCode → int

The hash code for this object.

no setter, inherited

hideQrScan → bool?

hides the qr functionality if set to true

final

hideReferences → bool?

hides the references to webpages if set to true

final

logo → Widget?

if logo is not null then displays the widget in the left side of appbar else displays nothing.

final

nextScreen → Widget?

after successful onboarding will gets redirected to this screen if it is not null.

final

onboard ↔ dynamic Function(Map<String?, AtClientService>, String?)

Function returns atClientServiceMap on successful onboarding along with onboarded @sign.

getter/setter pair

onError → dynamic Function(Object?)

Function returns error when failed in onboarding the existing or given atsign if nextScreen is null;

final

rootEnvironment → RootEnvironment

Setting up RootEnvironment to Staging will use the staging environment for onboarding.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited