ClerkAuth class

Control widget initialising Clerk Auth system

Inheritance

Constructors

ClerkAuth.new({Key? key, required Widget child, ClerkAuthConfig? config, Persistor? persistor, HttpService? httpService, ClerkAuthState? authState, Stream<ClerkDeepLink?>? deepLinkStream})
Construct a ClerkAuth
const

Properties

authState → ClerkAuthState?
auth instance from elsewhere
final
child → Widget
child widget tree
final
config → ClerkAuthConfig
The ClerkAuthConfig object
no setter
deepLinkStream → Stream<ClerkDeepLink?>?
A stream of deep links that the host app thinks the Clerk SDK might be interested in
final
hashCode → int
The hash code for this object.
no setterinherited
httpService → HttpService?
An override for the default clerk.HttpService
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
persistor → Persistor?
An override for the default clerk.Persistor
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() → State<ClerkAuth>
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, int wrapWidth = 65}) → 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

Static Methods

displayConfigOf(BuildContext context) → DisplayConfig
Get the clerk.DisplayConfig
errorStreamOf(BuildContext context) → Stream<AuthError>
get the stream of clerk.AuthError
fileCacheOf(BuildContext context) → ClerkFileCache
get the ClerkFileCache of the ClerkAuthConfig
localizationsOf(BuildContext context) → ClerkSdkLocalizations
Get the ClerkTranslator
materialAppBuilder({required ClerkAuthConfig config, Stream<ClerkDeepLink>? deepLinkStream}) → TransitionBuilder
Constructor to use when using MaterialApp for your project.
of(BuildContext context, {bool listen = true}) → ClerkAuthState
Get the context's nearest ClerkAuthState with rebuild on change
sessionOf(BuildContext context) → Session?
Get the most recent clerk.Session object
userOf(BuildContext context) → User?
Get the most recent clerk.User object