The SearchableIndex module is used to add or remove Ti.App.iOS.SearchableItem objects from the device search index.
To effectively add and remove information from the iOS search index you will need to use the following modules:
Ti.App.iOS.SearchableItemTi.App.iOS.SearchableIndexTi.App.iOS.SearchableItem objects to the device search indexTo use this feature make sure you have a compatible device running iOS 9 or later.
The following example demonstrates how to create a new Ti.App.iOS.SearchableItem and add a Ti.App.iOS.SearchableItemAttributeSet. The Ti.App.iOS.SearchableItem is then passed to the Ti.App.iOS.SearchableIndex object to add it to the on-device search index.
var searchItems = [];
var itemAttr = Ti.App.iOS.createSearchableItemAttributeSet({
itemContentType: Ti.App.iOS.UTTYPE_IMAGE,
title:"Titanium Core Spotlight Tutorial",
contentDescription:"Tech Example \nOn: " + String.formatDate(new Date(),"short"),
keywords:["Mobile","Appcelerator","Titanium"]
});
var item = Ti.App.iOS.createSearchableItem({
identifier:"my-id",
domainIdentifier:"com.mydomain",
attributeSet:itemAttr
});
searchItems.push(item);
var indexer = Ti.App.iOS.createSearchableIndex();
indexer.addToDefaultSearchableIndex([searchItems],function(e){
if(e.success){
alert("Press the home button and now search for your keywords");
}else{
alert("Errored: " + JSON.stringify(e.error));
}
});
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.
Adds an array of Titanium.App.iOS.SearchableItem objects to the default search index.
Requires: iOS 9.0 and later
Array of Titanium.App.iOS.SearchableItem objects to be added to the default search index.
Function to invoke on success or failure of adding the array Titanium.App.iOS.SearchableItem object to the default search index.
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.
Removes search items based on an array of domain identifiers.
Requires: iOS 9.0 and later
Array of domain identifiers to be removed from the default search index.
Function to invoke on success or failure of removing search items from the default search index.
Removes all search items added by the application.
Requires: iOS 9.0 and later
Function to invoke on success or failure of deleting all search items.
Removes search items based on an array of identifiers.
Requires: iOS 9.0 and later
Array of identifiers to be removed from the default search index.
Function to invoke on success or failure of removing search items from the default search index.
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.
Indicates whether indexing is supported by the device.
Requires: iOS 9.0 and later
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.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.