(Beta)
| Package | com.adobe.livecycle.assetmanager.client |
| Interface | public interface ISearchProvider extends IEventDispatcher |
| Implementors | SearchManager |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Public Properties
| Property | Defined By | ||
|---|---|---|---|
| lastQuery : SearchQuery [read-only]
Returns the search query associated with the result of the last search. | ISearchProvider | ||
| lastResult : ListCollectionView [read-only]
Returns the result of the last search. | ISearchProvider | ||
Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods| Method | Defined By | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
releaseSearchResults(resultsListView:ListCollectionView, assetDescriptor:com.adobe.livecycle.assetmanager.client.model:AssetTypeDescriptor):void
Releases the search results and does any clean up tasks that are required. | ISearchProvider | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Searches assets based on the specified search query. | ISearchProvider | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Thrown when SearchManager has completed searching. | ISearchProvider | |||
| Thrown when SearchManager encounters an error during search. | ISearchProvider | |||
Property Detail
lastQuery | property |
lastQuery:SearchQuery [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns the search query associated with the result of the last search. This function is updated when the lastResults function is updated.
Implementation
public function get lastQuery():SearchQuerylastResult | property |
lastResult:ListCollectionView [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns the result of the last search.
Implementation
public function get lastResult():ListCollectionViewMethod Detail
releaseSearchResults | () | method |
public function releaseSearchResults(resultsListView:ListCollectionView, assetDescriptor:com.adobe.livecycle.assetmanager.client.model:AssetTypeDescriptor):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Releases the search results and does any clean up tasks that are required. For example, disabling automatic synchronization provided by the Data Management Service.
Parameters
resultsListView:ListCollectionView — Search results to release.
| |
assetDescriptor:com.adobe.livecycle.assetmanager.client.model:AssetTypeDescriptor — AssetTypeDescriptor of the current asset, listed in the results grid.
|
search | () | method |
public function search(query:SearchQuery, resultsListView:ListCollectionView = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Searches assets based on the specified search query.
Parameters
query:SearchQuery — A SearchQuery object.
| |
resultsListView:ListCollectionView (default = null) |
Event Detail
searchComplete | Event |
Event Object Type:
com.adobe.livecycle.assetmanager.client.event.SearchEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Thrown when SearchManager has completed searching.
searchError | Event |
Event Object Type:
mx.rpc.events.FaultEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Manager Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Thrown when SearchManager encounters an error during search.
Wed Nov 21 2018, 06:34 AM -08:00