Merge pull request #17 from lmcjt37/patch-1

Added plist info definition for Face ID
tidev · May 31, 2018 · d331f6b · d331f6b
2 parents 470e730 + 0bf5126
commit d331f6b
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/apidoc/Identity.yml b/apidoc/Identity.yml
@@ -56,6 +56,26 @@ description: |
         } else if (TiIdentity.biometryType === TiIdentity.BIOMETRY_TYPE_TOUCH_ID) { // Touch ID
             authPhrase = 'Touch ID';
         }
+        
+    ## Face ID Requirements (iOS only)
+
+    For Face ID to work properly, you need to add a **`<key>`** item to the
+    **`<plist>`** element of your `tiapp.xml` file:
+
+        <ti:app>
+          ...
+          <ios>
+            ...
+            <plist>
+              <dict>
+                <key>NSFaceIDUsageDescription</key>
+                <string>Why you need Face ID.</string>
+              </dict>
+            </plist>
+            ...
+          </ios>
+          ...
+        </ti:app>
 
     ### Native Keychain Integration