For iOS, this package is not needed as the SMS autofill is provided by default, but not for Android, that's where this package is useful.
No permission to read SMS messages is asked to the user as there no need thanks to SMSRetriever API.
You have two widgets at your disposable for autofill an SMS code, PinFieldAutoFill and TextFieldPinAutoFill.
Just before you sent your phone number to the backend, you need to let know the plugin that it need to listen for the SMS with the code.
To do that you need to do:
This will listen for the SMS with the code during 5 minutes and when received, autofill the following widget.
PinFieldAutoFill( decoration: // UnderlineDecoration, BoxLooseDecoration or BoxTightDecoration see https://github.com/TinoGuo/pin_input_text_field for more info, currentCode: // prefill with a code onCodeSubmitted: //code submitted callback onCodeChanged: //code changed callback codeLength: //code length, default 6 ),
TextFieldPinAutoFill( decoration: // basic InputDecoration currentCode: // prefill with a code onCodeSubmitted: //code submitted callback onCodeChanged: //code changed callback codeLength: //code length, default 6 ),
Android SMS constraint #
For the code to be receive, it need to follow some rules as describe here: https://developers.google.com/identity/sms-retriever/verify
- Be no longer than 140 bytes
- Begin with the prefix <#>
- Contain a one-time code that the client sends back to your server to complete the verification flow
- End with an 11-character hash string that identifies your app
One example of SMS would be:
<#> ExampleApp: Your code is 123456 FA+9qCX9VSu
PhoneFieldHint [Android only]
PhoneFieldHint is a widget that will allow you ask for system phone number and autofill the widget if a phone is choosen by the user.
Custom CodeAutoFill #
If you want to create a custom widget that will autofill with the sms code, you can use the CodeAutoFill mixin that will offer you:
listenForCode()to listen for the SMS code from the native plugin when SMS is received, need to be called on your
cancel()to dispose the subscription of the SMS code from the native plugin, need to be called on your
codeUpdated()called when the code is received, you can access the value with the field
unregisterListener()to unregister the broadcast receiver, need to be called on your
App Signature #
To get the app signature at runtime just call the getter
SmsAutoFill. You can also find the sample code in example app.
- Compatibility with last flutter stable
- add obscureText to TextFieldPinAutoFill
- update deps
- Fix Android X compilation issue
- Fix Android X compilation issue
- Add Android signature helper
- Android X migration.
- Initial release.
Demonstrates how to use the sms_autofill plugin.
Getting Started #
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: sms_autofill: ^1.2.0
2. Install it
You can install packages from the command line:
$ flutter pub get
Alternatively, your editor might support
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Feb 12, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.7.1
- pana: 0.13.5
- Flutter: 1.12.13+hotfix.7
flutter format to format
The package description is too short. (-9 points)
Add more detail to the
description field of
pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.