[AC-5150] Disparity in Modules.TouchId documentation and example code
GitHub Issue | n/a |
---|---|
Type | Improvement |
Priority | n/a |
Status | Resolved |
Resolution | Done |
Resolution Date | 2017-08-18T20:41:18.000+0000 |
Affected Version/s | n/a |
Fix Version/s | n/a |
Components | n/a |
Labels | n/a |
Reporter | Luke Taylor |
Assignee | Shak Hossain |
Created | 2017-08-18T14:40:11.000+0000 |
Updated | 2017-09-07T21:47:20.000+0000 |
Description
The documentation(http://docs.appcelerator.com/platform/latest/#!/api/Modules.TouchId.KeychainItem) does not show a
reset
method but does show a delete
method.
The example code for the module ti.touchid(2.1.2) shows an example using reset instead of delete. This seems counter-intuitive to the docs above.
As a secondary point, when creating keychain items there are optional keys which aren't required. It is unclear that if you don't set an optional what the defaults would be. This could be quite integral to the security of an application and/or could hinder access also.
This was fixed already (see [here](https://github.com/appcelerator-modules/ti.touchid/commit/4f91ae470fc467f404afd5140033909be215b343)), but the webdocs are outdated. I will talk to our docs team to update them!