You are reading 12.5.1. See this page in 13.4.1.
Titanium.App.iOS.SearchableIndex
Extends Titanium.Proxy
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:
- Titanium.App.iOS.SearchableItemAttributeSet - Used to create metadata related to the
Ti.App.iOS.SearchableItem - Titanium.App.iOS.SearchableItem - Used to assemble metadata into a unique object package to be used by
Ti.App.iOS.SearchableIndex - Titanium.App.iOS.SearchableIndex - Used to add and remove
Ti.App.iOS.SearchableItemobjects to the device search index
To use this feature make sure you have a compatible device running iOS 9 or later.
Examples
Add Searchable Content to the On-Device Index
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.
app.js
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));
}
});
Properties 2
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
Methods 9
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
Adds an array of Titanium.App.iOS.SearchableItem objects to the default search index.
| Parameters | Type | Description |
|---|---|---|
| Array | Array<Titanium.App.iOS.SearchableItem> | Array of Titanium.App.iOS.SearchableItem objects to be added to the default search index. |
| callback | Callback<Dictionary> | Function to invoke on success or failure of adding the array Titanium.App.iOS.SearchableItem object to the default search index. |
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Removes search items based on an array of domain identifiers.
| Parameters | Type | Description |
|---|---|---|
| Array | Array<String> | Array of domain identifiers to be removed from the default search index. |
| callback | Callback<Dictionary> | Function to invoke on success or failure of removing search items from the default search index. |
Removes all search items added by the application.
| Parameters | Type | Description |
|---|---|---|
| callback | Callback<Dictionary> | Function to invoke on success or failure of deleting all search items. |
Removes search items based on an array of identifiers.
| Parameters | Type | Description |
|---|---|---|
| Array | Array<String> | Array of identifiers to be removed from the default search index. |
| callback | Callback<Dictionary> | Function to invoke on success or failure of removing search items from the default search index. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| event? | Dictionary | 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.
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|