| Package | com.adobe.icc.services.category |
| Interface | public interface ICategoryService extends IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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 | |
Determines if a category with the specified name and type exists. | ICategoryService | ||
Create a new category. | ICategoryService | ||
Deletes a category. | ICategoryService | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
Lists available categories. | ICategoryService | ||
Retrieves a category given its GUID. | ICategoryService | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
updateCategory(currentName:String, currentType:uint, newName:String, newType:uint):com.adobe.icc.token:IAsyncToken
Update the category specified by the given name and type, to the new name and type. | ICategoryService | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
categoryExists | () | method |
public function categoryExists(name:String, type:uint):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Determines if a category with the specified name and type exists.
Parameters
name:String — The name of the category sought.
| |
type:uint — The type of the category sought (from CategoryType constants).
|
com.adobe.icc.token:IAsyncToken — Boolean: True if the category exists; false if not.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Related API Elements
createCategory | () | method |
public function createCategory(name:String, type:uint):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Create a new category.
Parameters
name:String — New category name.
| |
type:uint — New category type (from CategoryType constants).
|
com.adobe.icc.token:IAsyncToken — The new Category object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Related API Elements
deleteCategory | () | method |
public function deleteCategory(categoryId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Deletes a category.
Parameters
categoryId:String — The ID (GUID) of the category to delete.
|
com.adobe.icc.token:IAsyncToken —
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
getAllCategories | () | method |
public function getAllCategories(query:Query = null):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Lists available categories.
Parameters
query:Query (default = null) |
com.adobe.icc.token:IAsyncToken — An ArrayCollection of Category objects that match the query.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Related API Elements
getCategory | () | method |
public function getCategory(categoryId:String):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a category given its GUID.
Parameters
categoryId:String — The ID (GUID) of the category to retrieve.
|
com.adobe.icc.token:IAsyncToken — The Category object retrieved.
|
Throws
Error — If the category ID is invalid.
|
Related API Elements
updateCategory | () | method |
public function updateCategory(currentName:String, currentType:uint, newName:String, newType:uint):com.adobe.icc.token:IAsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Update the category specified by the given name and type, to the new name and type.
Parameters
currentName:String — The name of the existing category.
| |
currentType:uint — The type of the existing category (from CategoryType constants).
| |
newName:String — The new name for the category.
| |
newType:uint — The type for the category (from CategoryType constants).
|
com.adobe.icc.token:IAsyncToken — The updated Category object.
|
Throws
Error — Throws ICCException with the appropriate error message and error code, if there was an error processing the request on the server.
|
Related API Elements
Thu Dec 4 2014, 05:50 PM -08:00