Packagecom.myflashlab.air.extensions.spotlight
Classpublic class Spotlight
InheritanceSpotlight Inheritance flash.events.EventDispatcher

The Spotlight ANE will let you index your suggested keywords even in runtime with user generated content and your search results will be immediately shown in the iOS spotlight window.



Public Properties
 PropertyDefined By
  isIndexingAvailable : Boolean
[read-only]
Spotlight
Public Methods
 MethodDefined By
  
To use Spotlight ANE, you should initialize it in your app the soonest possible and make sure that you have added the SpotlightEvents.SEARCH_SELECTED listener as early as possible.
Spotlight
  
deleteItems($identifiers:Array = null, $domainIdentifiers:Array = null):void
If you can add items to spotlight, you need to be able to delete them and this method does just that.
Spotlight
  
indexItems($itemsArray:Array):void
Call this method while passing in an Array of AttributeSet so the ANE can index these search items in the device.
Spotlight
Public Constants
 ConstantDefined By
  EXTENSION_ID : String = com.myflashlab.air.extensions.spotlight
[static]
Spotlight
  VERSION : String = 1.0.31
[static]
Spotlight
Property Detail
isIndexingAvailableproperty
isIndexingAvailable:Boolean  [read-only]


Implementation
    public function get isIndexingAvailable():Boolean
Constructor Detail
Spotlight()Constructor
public function Spotlight()

To use Spotlight ANE, you should initialize it in your app the soonest possible and make sure that you have added the SpotlightEvents.SEARCH_SELECTED listener as early as possible. The reason is that when a user selects your item from the spotlight search items, your app will be launched and the and the item's unique identifier string will be sent to the SEARCH_SELECTED event.

Notice: If you are testing your app in debug mode, the SpotlightEvents.SEARCH_SELECTED listener won't be dispatched when your app is launching because the debug connection process may take a while before the app starts and the event happens before you have the time to listen to it! We hope Adobe can fix this bug in future versions of Air SDK. However, when you test your app in release or adHoc mode, the SpotlightEvents.SEARCH_SELECTED listener will be dispatched everytime your app starts because of the spotlight search item being touched.

Method Detail
deleteItems()method
public function deleteItems($identifiers:Array = null, $domainIdentifiers:Array = null):void

If you can add items to spotlight, you need to be able to delete them and this method does just that. If you call this method without any parameters, it will delete all the items indexed before but you may use the method arguments to filter the type of information your wish to delete. The result of the process will be dispatched through SpotlightEvents.DELETING_SUCCESS or SpotlightEvents.DELETING_FAILURE.

Parameters

$identifiers:Array (default = null) — An Array of unique identifiers Strings which you wish to delete.
 
$domainIdentifiers:Array (default = null) — An Array of domain identifiers which you had used before for grouping your search items.

See also

indexItems()method 
public function indexItems($itemsArray:Array):void

Call this method while passing in an Array of AttributeSet so the ANE can index these search items in the device. The result of the process will be dispatched through SpotlightEvents.INDEXING_SUCCESS or SpotlightEvents.INDEXING_FAILURE.

Parameters

$itemsArray:Array

See also

Constant Detail
EXTENSION_IDConstant
public static const EXTENSION_ID:String = com.myflashlab.air.extensions.spotlight

VERSIONConstant 
public static const VERSION:String = 1.0.31