https://github.com/rdn87/cordova-plugin-gctouch-id
Touch ID Plugin (Cordova) for iOS
https://github.com/rdn87/cordova-plugin-gctouch-id
cordova-ios-plugin cordova-plugin cordova-plugin-touch-id javascript objective-c touch-id touchid
Last synced: 6 months ago
JSON representation
Touch ID Plugin (Cordova) for iOS
- Host: GitHub
- URL: https://github.com/rdn87/cordova-plugin-gctouch-id
- Owner: rdn87
- License: mit
- Created: 2017-05-09T23:17:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-13T16:18:16.000Z (almost 8 years ago)
- Last Synced: 2025-04-17T01:25:05.383Z (7 months ago)
- Topics: cordova-ios-plugin, cordova-plugin, cordova-plugin-touch-id, javascript, objective-c, touch-id, touchid
- Language: Objective-C
- Homepage:
- Size: 1.9 MB
- Stars: 20
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cordova-plugins - Touch ID NEW
- awesome-cordova-plugins - Touch ID NEW
README
# cordova-plugin-gctouch-id
Touch ID Plugin (Cordova) for iOS
Author: [Giulio Caruso aka rdn](https://twitter.com/iosdeveloper87)
[](https://developer.apple.com/reference/objectivec)
[](https://github.com/rdn87/cordova-plugin-gctouch-id/blob/master/LICENSE)
## Index
1. [Description](#1-description)
2. [Technical Documentation](2-technical-documentation)
3. [Screenshots](#3-screenshots)
4. [Adding the Plugin](#4-adding-the-plugin)
5. [Sample Code](#5-sample-code)
6. [To Do](#6-to-do)
7. [License](#7-license)
## 1. Description
With this plug-in Cordova you can use the TouchID sensor **(iPhone 5S/iPhone 6/iPhone 6 Plus/iPhone 7/iPhone 7 Plus/iPad with Touch ID Sensor)** for Authenticate in your App
The Plugin is only iOS Platform.
**Requirements**
===========
| **iOS** |
|---------|
| 8.0+ |
## 2. Technical Documentation
In this plugin there are 3 basic methods:
- `isAvailable`
- `authWithTouchID`
- `setPassword`
**[isAvailable]**: Returns a flag **true** or **false** if the touch id is available for that type of **Device**. (*No input parameters*)
**[authWithTouchID]**: This method tries to access with **Touch ID**
*These are input parameters:*
**insertPwd**: In this parameter you can enter the **string** true or false, set false if u want Basic Authentication with only Touch ID (*Optional if u want Basic Authentication only Touch ID*)
**textValue**: In this parameter you can enter the **string** for label of Button (*Required*)
**message**: In this parameter you can enter the **string** for Touch ID popup text (*Required*)
**security**: In this parameter you can enter the **string** true or false, false for Auth with **NSUsersDefaults** Instead it is true to use the **KeyChain** (Optional if u want Basic Authentication only Touch ID)
**[setPassword]**: This method allows you to save in **NSUsersDefaults** or **KeyChain** your password that you have chosen as Fallback.
*These are input parameters:*
**password**: In this parameter you can enter the **string** of your password
**security**: In this parameter you can enter the **string** true or false, false for Auth with **NSUsersDefaults** Instead it is true to use the **KeyChain**
## 3. Screenshot
# 4. Adding the Plugin
Use the Cordova CLI and type in the following command:
`cordova plugin add https://github.com/rdn87/cordova-plugin-gctouch-id.git`
# 5. Sample Code
You can find it in the DEMO folder.
# 6. TO DO
- [x] Add Basic Authentication with Touch ID
- [x] Add NSUsersDefaults support
- [x] Add UITextField input text support
- [x] Add Keychain support
- [x] Improve code
- [x] Add npm repo
# 7. License
cordova-plugin-gctouch-id is available under the MIT license. See the **[LICENSE](https://github.com/rdn87/cordova-plugin-gctouch-id/blob/master/LICENSE)** file for more info.