clerk_auth library
Package that will allow you to authenticate and use Clerk from Dart code.
Classes
- Actions
- Actions Clerk object
- AttackProtection
- AttackProtection Clerk object
- Auth
- Auth provides more abstracted access to the Clerk API.
- AuthConfig
- An object holding all configurable items required for Auth, with sensible defaults
- ClerkConstants
- constant values
- Client
- Client Clerk object
- Config
- Config Clerk object
- DefaultHttpService
- Default implementation of HttpService
- DefaultPersistor
- A default Persistor that just writes a cache of values to the file system
- DisplayConfig
- Display Configuration
- Email Clerk object
- Environment
- Environment Clerk object
- Epoch
- An implementation of DateTime that represents the epoch exclusively
- ExternalAccount
- ExternalAccount Clerk object
- Factor
- Factor Clerk object
- Field
- Pseudo-enum representing fields
- HttpService
- Abstract class defining the interface to call the Clerk back-end over http
- Level
- Levels to control logging output. Logging can be enabled to include all levels above certain Level. Levels are ordered using an integer value Level.value. The predefined Level constants below are sorted as follows (in descending order): Level.SHOUT, Level.SEVERE, Level.WARNING, Level.INFO, Level.CONFIG, Level.FINE, Level.FINER, Level.FINEST, and Level.ALL.
- Organization
- Organization Clerk object
- OrganizationActions
- OrganizationActions Clerk object
- OrganizationDomain
- OrganizationDomain Clerk object
- OrganizationInvitation
- OrganizationInvitation Clerk object
- OrganizationMembership
- OrganizationMembership Clerk object
- OrganizationSettings
- OrganizationSettings Clerk object
- Passkey
- Passkey Clerk object
- PasskeySettings
- PasskeySettings Clerk object
- PasswordSettings
- PasswordSettings Clerk object
- Permission
- Pseudo-enum representing permissions
- Persistor
- Abstract class defining the persistence interface for values required to allow seamless auth across app runs
- PhoneNumber
- PhoneNumber Clerk object
- Printer
- A class which is responsible for outputting to the console. Must implement a print method.
- Restrictions
- Restrictions Clerk object
- Session
- Session Clerk object
- SessionToken
- SessionToken Clerk object
- SignIn
- SignIn Clerk object
- SignInSettings
- SignInSettings Clerk object
- SignUp
- SignUp Clerk object
- SignUpSettings
- SignUpSettings Clerk object
- SocialConnection
- SocialConnection Clerk object
- Status
- Pseudo-enum representing fields
- Strategy
- Strategy Clerk object
- Telemetry
- Telemetry
- User
- User Clerk object
- UserAttributeData
- UserAttributeData Clerk object
- UserIdentifyingData
- Abstract class to be parent to e.g. PhoneNumber and Email so that both can be used as an identifier
- UserLockout
- UserLockout Clerk object
- UsernameSettings
- UsernameSettings Clerk object
- UserPublic
- UserPublic Clerk object
- UserSettings
- UserSettings Clerk object
- Verification
- Verification Clerk object
- Web3Wallet
- Web3Wallet Clerk object
Enums
- AuthErrorCode
- Code to enable consuming apps to identify the error
- EnrollmentMode
- EnrollmentMode Clerk object
- HttpMethod
- Enum detailing HttpMethods used by the Clerk API
- IdentifierType
- IdentifierType object
- InstanceType
- InstanceType Clerk object
- SessionTokenPollMode
-
SessionTokenPollMode manages how to refresh the
sessionToken - Stage
- Stage Clerk object
- UserAttribute
- UserAttribute Clerk object
Mixins
- Logging
- Mixin to hide some of the boilerplate around initializing and using a logger.
Extensions
- DateTimeExt on DateTime
- Extension class to create extra statics for DateTime use
- DurationExt on Duration
- Extension class for Duration
-
ListExtension
on List<
T> - Extensions to the List class
-
MapExtension
on Map<
T, S> - Extensions to the Map class
- ObjectIdentity on Object
- Extension on Object useful for debugging
- StringExtension on String
- Extensions to the String class
Functions
-
runWithLogging(
Future< void> fn()) → Future<void> -
Run
fnwith logging enabled -
setUpLogging(
{required Printer printer, bool structuredLogging = false, Level level = Level.ALL}) → Future< void> - Set up logging
Typedefs
-
LocalesLookup
= List<
String> Function() -
Used by
Apito locate the current user locale preference.
Exceptions / Errors
- AuthError
- Container for errors encountered during Clerk auth(entication|orization)