Titanium SDK

# Titanium.App.iOS.SearchableIndex

The SearchableIndex module is used to add or remove Ti.App.iOS.SearchableItem objects from the device search index.

Availability
5.0.0
9.2.0
Extends
Titanium.Proxy

# Overview

To effectively add and remove information from the iOS search index you will need to use the following modules:

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

# apiName READONLY

Availability
5.0.0
9.2.0
apiName :String

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, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability
5.0.0
9.2.0
bubbleParent :Boolean

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

# Methods

# addEventListener

Availability
5.0.0
9.2.0
addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# addToDefaultSearchableIndex

Availability
5.0.0
9.2.0
addToDefaultSearchableIndex(Array, callback) → void

Adds an array of Titanium.App.iOS.SearchableItem objects to the default search index.

Parameters

Name 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.

Returns

Type
void

# applyProperties

Availability
5.0.0
9.2.0
applyProperties(props) → void

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.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# deleteAllSearchableItemByDomainIdenifiers

Availability
5.0.0
9.2.0
deleteAllSearchableItemByDomainIdenifiers(Array, callback) → void

Removes search items based on an array of domain identifiers.

Parameters

Name 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.

Returns

Type
void

# deleteAllSearchableItems

Availability
5.0.0
9.2.0
deleteAllSearchableItems(callback) → void

Removes all search items added by the application.

Parameters

Name Type Description
callback Callback<Dictionary>

Function to invoke on success or failure of deleting all search items.

Returns

Type
void

# deleteSearchableItemsByIdentifiers

Availability
5.0.0
9.2.0
deleteSearchableItemsByIdentifiers(Array, callback) → void

Removes search items based on an array of identifiers.

Parameters

Name 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.

Returns

Type
void

# fireEvent

Availability
5.0.0
9.2.0
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name 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.

Returns

Type
void

# isSupported

Availability
5.0.0
9.2.0
isSupported() → Boolean

Indicates whether indexing is supported by the device.

Returns

Type
Boolean

# removeEventListener

Availability
5.0.0
9.2.0
removeEventListener(name, callback) → void

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);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

Returns

Type
void

Contents