(Beta)
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 1.0, 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 | ||
Creates a category. | ICategoryService | ||
Deletes a category. | ICategoryService | ||
![]() |
Dispatches an event into the event flow. | IEventDispatcher | |
Lists available categories. | ICategoryService | ||
Retrieves a category with the specified globally unique identifier. | 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
Updates the category specified by the given name and type to a 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 1.0, 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 to look for.
| |
type:uint — The type of the category to look for. One of the CategoryType constants.
|
com.adobe.icc.token:IAsyncToken — A Boolean . The value is true if the category exists. If the category does not exist, the value is false.
|
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 1.0, Flash Player 9, Flash Player 10 |
Creates a category.
Parameters
name:String — The category name.
| |
type:uint — One of the CategoryType constants.
|
com.adobe.icc.token:IAsyncToken — The 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 9.5 |
Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Deletes a category.
Parameters
categoryId:String — The identifier of the category to delete. That is, the GUID.
|
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 1.0, Flash Player 9, Flash Player 10 |
Lists available categories.
Parameters
query:Query (default = null ) — A query that specifies the statements used to filter search results. Leave null to retrieve all categories.
|
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 1.0, Flash Player 9, Flash Player 10 |
Retrieves a category with the specified globally unique identifier. That is, the GUID.
Parameters
categoryId:String — The identifier of the category to retrieve. That is, the GUID.
|
com.adobe.icc.token:IAsyncToken — The retrieved Category object.
|
Throws
Error — Thrown 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 1.0, Flash Player 9, Flash Player 10 |
Updates the category specified by the given name and type to a new name and type.
Parameters
currentName:String — The name of the existing category.
| |
currentType:uint — The type of the existing category. One of the CategoryType constants.
| |
newName:String — The new name for the category.
| |
newType:uint — The type for the category. One of the 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
Wed Nov 21 2018, 06:34 AM -08:00