Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
cordova-plugin-sms-retriever
Advanced tools
cordova-plugin-sms-retriever - npm Package Compare versions
Comparing version 2.0.0 to 2.0.1
| { | ||
| "name": "cordova-plugin-sms-retriever", | ||
| "version": "2.0.0", | ||
| "version": "2.0.1", | ||
| "description": "Cordova plugin to retrieve SMS in Android using the SMS Retriever API.", | ||
@@ -5,0 +5,0 @@ "cordova": { |
@@ -1,4 +0,2 @@ | ||
| | License | Platform | Contribute | | ||
| | --- | --- | --- | | ||
| |  |  | [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G33QACCVKYD7U) | | ||
|   [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=G33QACCVKYD7U) | ||
@@ -26,8 +24,8 @@ # cordova-plugin-sms-retriever | ||
| ## startWatch | ||
| Start listening for a single incoming [verification SMS](https://developers.google.com/identity/sms-retriever/verify#1_construct_a_verification_message "verification SMS"). for 5 minutes. | ||
| Start listening for a single incoming [verification SMS](https://developers.google.com/identity/sms-retriever/verify#1_construct_a_verification_message "verification SMS") for 5 minutes. | ||
| :warning: method moved from **window** to **cordova.plugins** object in version 2.0.0 | ||
| :warning: Method moved from **window** to **cordova.plugins** object in version 2.0.0 | ||
| - When a valid SMS is intercepted, the **onSMSArrive** event is fired and SMS watching is stopped. | ||
| - When the 5 minutes timeout is reached, SMS watching is stopped and the failureCallback returns **TIMEOUT**. | ||
| - When the 5 minutes timeout is reached, SMS watching is stopped and the **failureCallback** returns **TIMEOUT**. | ||
@@ -40,3 +38,3 @@ ### Return values | ||
| When and SMS is returned, the SMS retriever API is automatically stopped and no further messages will be intercepted until you start a new one. This is by API design, not a plugin or a demo app restriction. | ||
| When the SMS is returned, the retriever API is automatically stopped and no further messages will be intercepted until you start a new one. This is by API design, not a plugin or a demo app restriction. | ||
@@ -57,11 +55,16 @@ ### Example | ||
| Get the 11-character hash string for your app using the [AppSignatureHelper](https://github.com/googlesamples/android-credentials/blob/master/sms-verification/android/app/src/main/java/com/google/samples/smartlock/sms_verify/AppSignatureHelper.java "AppSignatureHelper") class. This string must be appended to the SMS received in order for the API to read this message. The hash will be different from debug and release builds, since they have different signatures. | ||
| Get the 11-character hash string for your app using the [AppSignatureHelper](https://github.com/googlesamples/android-credentials/blob/master/sms-verification/android/app/src/main/java/com/google/samples/smartlock/sms_verify/AppSignatureHelper.java "AppSignatureHelper") class. This string must be appended to the SMS received in order for the API to read this message. | ||
| :warning: Method moved from **window** to **cordova.plugins** object in version 2.0.0 | ||
| :warning: Caling this method with an active SMS retriever running will **void** the retriever and the SMS wont be incercepted. | ||
| :warning: Google advices against dynamically retrieving your hash code before sending the SMS: | ||
| ### Remarks | ||
| - The hash will be different from debug and release builds, since they have different signatures. | ||
| - Play Store now re-signs signed APKs on upload. This will most certainly change the hash string. | ||
| - Calling this method with an active SMS retriever running will **void** the retriever and the SMS wont be incercepted. | ||
| - Google advices against dynamically retrieving your hash code before sending the SMS: | ||
| > Do not use hash strings dynamically computed on the client in your verification messages. | ||
| Therefore, do **not** invoke this method from the published app. The hash is the same for all users, and bound to your keystore signing keys, so you can get it once and never again call **getHashString**. | ||
| Therefore, **do not** invoke this method from the published app. The hash is the same for all users, and bound to your keystore signing keys, so you can get it once and never again call this method. | ||
@@ -90,2 +93,6 @@ ### Return values | ||
| ### Remarks | ||
| - If the SMS is not retrieved in your debug build, try the signed production APK. | ||
| ### Example | ||
@@ -106,17 +113,22 @@ | ||
| - Be no longer than 140 bytes | ||
| - ~~Begin with the prefix <#>~~ *No longer needed since plugin version **2.0.0*** | ||
| - Begin with the prefix <#> | ||
| - Contain a one-time code that the client sends back to your server to complete the verification flow | ||
| - End with the 11-character hash string that identifies your app | ||
| ### Remarks | ||
| - Starting from **plugin 2.0.0**, the <#> prefix is no longer required by the plugin. | ||
| - Starting from an unknown **Play Services** version, the <#> is no longer required. | ||
| Otherwise, the contents of the verification message can be whatever you choose. It is helpful to create a message from which you can easily extract the one-time code later on. For example, a valid verification message might look like the following: | ||
| AZC123 is your code for andreszsogon.com SMS Retriever Demo App. hi5c8+bkQy0 | ||
| <#> AZC123 is your code for andreszsogon.com SMS Retriever Demo App. hi5c8+bkQy0 | ||
| :information_source: It is a good practice to prepend the verification code to the beginning of the SMS, in case the retriever fails, the user can see the code immediately from the notification bar. | ||
| # Demo App by Andrés Zsögön | ||
| # Plugin demo app | ||
| You can download the [SMS Retriever plugin demo app](https://www.andreszsogon.com/cordova-sms-retriever-plugin-demo-app/) from the Play Store; its source code is provided in the **demo** folder. | ||
| [](https://www.andreszsogon.com/cordova-sms-retriever-plugin-demo-app/ "") [](https://www.andreszsogon.com/cordova-sms-retriever-plugin-demo-app/ "") [](https://www.andreszsogon.com/cordova-sms-retriever-plugin-demo-app/ "") | ||
| [](https://www.andreszsogon.com/cordova-sms-retriever-plugin-demo-app/) [](https://www.andreszsogon.com/cordova-sms-retriever-plugin-demo-app/) | ||
@@ -145,19 +157,17 @@ # FAQ | ||
| ### When was the <#> SMS prefix removed? | ||
| The <#> prefix formerly required to retrieve the SMS was silently removed in an unknown Play Services version and no longer appears in the SMS Retriever API docs. | ||
| # Changelog | ||
| ### 2.0.1 | ||
| - Updated README with important details about SMS generation | ||
| ### 2.0.0 | ||
| - :warning: Methods moved from the global **window** to the **cordova.plugins** object | ||
| - Improved all methods return values to make them easier to parse | ||
| - Removed the requirement include the <#> prefix in the SMS | ||
| - Improved stability and error checking | ||
| - Updated demo app, now available in Play Store | ||
| ### 1.1.1 | ||
| - Removed the `cordova-support-google-services` plugin dependency which is no longer required | ||
| ### 1.1.0 | ||
| - Added `cordova >= 7.1.0` engine to config.xml | ||
| - Added `cordova-android >= 6.3.0` engine to config.xml | ||
| - Added missing `com.google.android.gms:play-services-auth` framework to config.xml | ||
| - Bumped `PLAY_SERVICES_VERSION` to 15.0.0 in config.xml | ||
| - **Notice**: This plugin requires `classpath com.android.tools.build:gradle:4.0.1` in build.gradle, otherwise your build will probably fail with Cordova 9.0.0. | ||
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Number of lines in readme file
- increased by6.33%
168
Worsened metrics
- Total package byte prevSize
- decreased by-93.85%
22679
- Number of package files
- decreased by-50%
8
- Lines of code
- decreased by-96.15%
20
No dependency changes