OTPTextEditController class

Custom controller for text views, IOS autofill is built in flutter.

Inheritance

Constructors

OTPTextEditController({required int codeLength, StringCallback? onCodeReceive, VoidCallback? onTimeOutException, dynamic errorHandler(Exception error)?, bool autoStop = true, OTPInteractor? otpInteractor, PlatformWrapper? platform})

Properties

autoStop → bool
Stop listening after receiving or error an OTP code.
final
codeLength → int
OTP code length - trigger for callback.
final
errorHandler → (dynamic Function(Exception error)?)
Error handler.
final
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
onCodeReceive → StringCallback?
OTPTextEditController's receive OTP code callback.
final
onTimeOutException → VoidCallback?
Receiver gets TimeoutError after 5 minutes without sms.
final
otpInteractor → OTPInteractor
Interaction with OTP.
final
platform → PlatformWrapper
Wrapper for Platform io.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
selection ↔ TextSelection
The currently selected text.
getter/setter pairinherited
text ↔ String
The current string the user is editing.
getter/setter pairinherited
value ↔ TextEditingValue
The current value stored in this notifier.
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
buildTextSpan({required BuildContext context, TextStyle? style, required bool withComposing}) → TextSpan
Builds TextSpan from current editing value.
inherited
checkForComplete() → void
Call onComplete callback if code entered.
clear() → void
Set the value to empty.
inherited
clearComposing() → void
Set the composing region to an empty range.
inherited
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
isSelectionWithinTextBounds(TextSelection selection) → bool
Check that the selection is inside of the bounds of text.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
startListenOnlyStrategies(List<OTPStrategy>? strategies, ExtractStringCallback codeExtractor) → void
Get OTP code from another input don't register any BroadcastReceivers.
startListenRetriever(ExtractStringCallback codeExtractor, {List<OTPStrategy>? additionalStrategies}) → Future<void>
Start listen for OTP code with Retriever API sms by default could be added another input as OTPStrategy.
startListenUserConsent(ExtractStringCallback codeExtractor, {List<OTPStrategy>? strategies, String? senderNumber}) → Future<void>
Start listen for OTP code with User Consent API sms by default could be added another input as OTPStrategy.
stopListen() → Future<Object?>
Broadcast receiver stop listen for OTP code, use in dispose.
toString() → String
A string representation of this object.
inherited

Operators

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