Represents a keychain item.
The following example demonstrates the basic usage to save, read and delete values with the native iOS keychain:
// Create a keychain item
var keychainItem = TouchID.createKeychainItem({
identifier: 'password'
});
// Triggered when the keychain item was successfully saved
keychainItem.addEventListener('save', function(e) {
// Notify the user that the operation succeeded or failed
});
// Write to the keychain
keychainItem.save('s3cr3t_p4$$w0rd');
For advanced security options, you can specify accessibility mode to the keychain that will be applied when writing items to the keychain, for example:
// Create a keychain item
var keychainItem = TouchID.createKeychainItem({
identifier: 'mypassword',
accessGroup: '<YOUR-TEAM-ID>.com.appc.touchidtest',
accessibilityMode: TouchID.ACCESSIBLE_WHEN_PASSCODE_SET_THIS_DEVICE_ONLY,
accessControlMode: TouchID.ACCESS_CONTROL_TOUCH_ID_ANY,
// Pass more native options to the keychain. Since there are hundrets of them,
// look up the value of the constant and pass it here. Example:
options: {
// The value of kSecUseOperationPrompt
'u_OpPrompt': 'Please authenticate yourself!'
}
});
The name of the API that this proxy corresponds to.
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.
Default: true
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
A dictionary of properties to apply.
Asynchronously determines whether or not a value of the specified identifier exists in the keychain item.
Use the event key exists of the callback to determine the
existence of the keychain item.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Reads an existing value to the iOS keychain.
The error key informs you
about the exact error.
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Resets an existing value from the iOS keychain.
The error key informs you
about the exact error.
Saves a new value to the iOS keychain.
The error key informs you
about the exact error.
On Android this will also overwrite any existing value.
The value to be stored in the keychain.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Updates an existing value to the iOS keychain.
The error key informs you
about the exact error.
The value to be stored in the keychain.
Triggered when a new keychain item is red (or an error occurred).
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Triggered when a new keychain item is resetted (or an error occurred).
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Triggered when a new keychain item is saved (or an error occurred).
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Triggered when a new keychain item is updated (or an error occurred).
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.