Titanium Mobile

# Titanium.App.iOS.SearchableItem

Used to create a unique object containing all of the search information that will appear in 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 below listed modules:

To use this feature make sure you have a compatible device running iOS 9 or later.

To create a SearchableItem object, use the Titanium.App.iOS.createSearchableItem method. Pass a dictionary of properties to the method that will help identify the item. At minimum, you must set the Titanium.App.iOS.SearchableItem.attributeSet property, which associates the metadata with the SearchableItem object.

Then, pass the SearchableItem object to a SearchableIndex object's Titanium.App.iOS.SearchableIndex.addToDefaultSearchableIndex method to add the item to the device's search index.

# 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({
    uniqueIndentifier:"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

# attributeSet CREATION ONLY

Availability
5.0.0
9.2.0
attributeSet :Titanium.App.iOS.SearchableItemAttributeSet

Set of metadata properties to display for the item.

Must be set to create a SearchableItem object.

# domainIdentifier

Availability
5.0.0
9.2.0
domainIdentifier :String

Identifier that represents the "domain" or owner of this item.

# expirationDate

Availability
5.0.0
9.2.0
expirationDate :String

Searchable items have an expiration date or time to live. By default it is set to one month.

Absolute date after which the activity is no longer eligible to be indexed or handed off.

The date will be a string in the following format: "yyyy-MM-dd'T'HH:mm:ss.SSS'+0000'" For example, 2015-12-25T23:30:55.978+0000

# uniqueIdentifier

Availability
5.0.0
9.2.0
uniqueIdentifier :String

Unique identifier to your application group.

Contents