clerk_auth library
Package that will allow you to authenticate and use Clerk from Dart code.
Classes
- Actions
- Actions Clerk object
- Api
- Api manages communication with the Clerk frontend API
- ApiError
- ApiError Clerk object
- ApiResponse
- ApiResponse holds parsed Clerk data from a back-end http response
- AttackProtection
- AttackProtection Clerk object
- Auth
- Auth provides more abstracted access to the Clerk API
- AuthConfig
- AuthConfig Clerk object
- ClerkConstants
- constant values
- Client
- Client 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
- Factor
- Factor Clerk object
- HttpService
- Abstract class defining the interface to call the Clerk back-end over http
- Organization
- Organization Clerk object
- OrganizationActions
- OrganizationActions Clerk object
- OrganizationDomains
- OrganizationDomains Clerk object
- OrganizationMembership
- OrganizationMembership Clerk object
- OrganizationSettings
- OrganizationSettings Clerk object
- Passkey
- Passkey Clerk object
- PasskeySettings
- PasskeySettings Clerk object
- PasswordSettings
- PasswordSettings Clerk object
- 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
- Strategy
- Strategy Clerk object
- TelemetricEvent
- A TelemetricEvent to be sent to the backend
- 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
- EnrollmentMode
- EnrollmentMode Clerk object
- Field
- Field Clerk object
- HttpMethod
- Enum detailing HttpMethods used by the Clerk API
- IdentificationStrategy
- IdentificationStrategy Clerk object
- IdentifierType
- IdentifierType object
- InstanceType
- InstanceType Clerk object
- SessionTokenPollMode
-
SessionTokenPollMode manages how to refresh the
sessionToken - Stage
- Stage Clerk object
- Status
- Status 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
-
ListExtension
on List<
T> - Extensions to the List class
-
MapExtension
on Map<
T, S> - Extensions to the Map class
- StringExtension on String
- Extensions to the String class
Constants
- packageVersion → const String
Functions
-
intToDateTime(
dynamic input) → DateTime? - Convert a value to a DateTime?. For JsonSerializable
-
isOn(
dynamic on) → bool -
trueif a value is'on', elsefalse. For JsonSerializable -
isTrue(
dynamic boolean) → bool -
trueif a value istrue, elsefalse. For JsonSerializable -
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
-
toStrategyList(
dynamic data) → List< Strategy> - Returns a list of recognised Strategys. For JsonSerializable
Exceptions / Errors
- AuthError
- Container for errors encountered during Clerk auth(entication|orization)