OnboardingWidget class - onboarding_widget library

Constructors

OnboardingWidget({Key? key, String? atsign, bool? hideReferences, bool? hideQrScan, 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 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
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 else it redirects to nextScreen.
final
hashCode → int: The hash code for this object.
no setterinherited
hideQrScan → bool?: final
hideReferences → bool?: hides the references to webpages if set to true
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
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.
final
onError → dynamic Function(Object?): Function returns error when failed in onboarding the existing or given atsign if nextScreen is null;
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _OnboardingWidgetState: Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited