| Package | com.adobe.gravity.tracker |
| Class | public class ServiceTracker |
| Inheritance | ServiceTracker  EventDispatcher Object |
| Implements | IServiceTrackerCustomizer |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| service : Object [read-only]
The highest-ranked service that matches the tracking criteria. | ServiceTracker | ||
| services : Array [read-only]
The set of services that are being tracked, in ranking order. | ServiceTracker | ||
| size : uint [read-only]
The number of services that currently match the tracking criteria. | ServiceTracker | ||
| trackingCount : uint [read-only]
A number that increments every time the set of tracked services changes. | ServiceTracker | ||
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| context : IBundleContext [read-only]
The bundle context for this tracker. | ServiceTracker | ||
| filter : IFilter [read-only]
The service filter that this tracker is using, if any. | ServiceTracker | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
ServiceTracker(context:IBundleContext, serviceInterface:Class, filter:IFilter = null, customizer:com.adobe.gravity.tracker:IServiceTrackerCustomizer = null)
Constructor. | ServiceTracker | ||
| 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. | EventDispatcher | |
Called when a new service appears that is to be tracked. | ServiceTracker | ||
Stop tracking services. | ServiceTracker | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Called when service properties are modified. | ServiceTracker | ||
Start tracking services. | ServiceTracker | ||
|
Indicates whether the specified property exists and is enumerable. | Object | |
Called when a service is no longer to be tracked. | ServiceTracker | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Property Detail
context | property |
context:IBundleContext [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
The bundle context for this tracker.
Implementation
protected function get context():IBundleContextfilter | property |
filter:IFilter [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
The service filter that this tracker is using, if any.
Implementation
protected function get filter():IFilterservice | property |
service:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
The highest-ranked service that matches the tracking criteria.
This property can be used as the source for data binding. When this property is modified, it dispatches the serviceChanged event.
Implementation
public function get service():Objectservices | property |
services:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
The set of services that are being tracked, in ranking order.
This property can be used as the source for data binding. When this property is modified, it dispatches the servicesChanged event.
Implementation
public function get services():Arraysize | property |
size:uint [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
The number of services that currently match the tracking criteria.
This property can be used as the source for data binding. When this property is modified, it dispatches the sizeChanged event.
Implementation
public function get size():uinttrackingCount | property |
trackingCount:uint [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
A number that increments every time the set of tracked services changes. Can be used to check whether there have been changes to the set of tracked services.
This property can be used as the source for data binding. When this property is modified, it dispatches the trackingCountChanged event.
Implementation
public function get trackingCount():uintConstructor Detail
ServiceTracker | () | Constructor |
public function ServiceTracker(context:IBundleContext, serviceInterface:Class, filter:IFilter = null, customizer:com.adobe.gravity.tracker:IServiceTrackerCustomizer = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
Constructor.
Parameterscontext:IBundleContext — A bundle context for performing service operations.
| |
serviceInterface:Class — The interface for the services to be tracked.
| |
filter:IFilter (default = null) | |
customizer:com.adobe.gravity.tracker:IServiceTrackerCustomizer (default = null) |
Method Detail
addingService | () | method |
public function addingService(reference:IServiceReference):com.adobe.gravity.utility.async:IToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
Called when a new service appears that is to be tracked. Note that implementations of this method must retrieve the service object from the service registry. The simplest implementation would be
public function addingService(reference:IServiceReference):IToken
{
return BundleContext.currentContext.getService(reference);
}
Parameters
reference:IServiceReference — The reference for the new service.
|
com.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. The success handler must be called with the object to be returned by the tracker as the service object.
|
close | () | method |
public function close():void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
Stop tracking services.
modifiedService | () | method |
public function modifiedService(reference:IServiceReference, service:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
Called when service properties are modified.
Parameters
reference:IServiceReference — The reference for the service.
| |
service:Object — The service object.
|
open | () | method |
public function open():com.adobe.gravity.utility.async:IToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
Start tracking services.
Returnscom.adobe.gravity.utility.async:IToken — A token used to set success and failure handlers to be called when the operation has completed. Success handlers will be called with no parameters.
|
removedService | () | method |
public function removedService(reference:IServiceReference, service:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10 |
| Runtime Versions: | AIR 1.1, Flash Player 9 |
Called when a service is no longer to be tracked. Note that implementations must release the service object from the service registry. The simplest implementation would be
public function removedService(reference:IServiceReference, service:Object):void
{
BundleContext.currentContext.ungetService(reference);
}
Parameters
reference:IServiceReference | |
service:Object |
Mon Apr 10 2017, 12:28 PM -07:00