Interface Facade

An interface for an object on which you can listen to events.

interface Facade {
    activateCategory(
        category: SelectableCategory,
    ): Result<void, "ERROR_CATEGORY_NOT_AVAILABLE">;
    addEventListener<K extends "onActiveCategoryChange">(
        event: K,
        listener: (eventData: CategoryAPI.Events[K]) => void,
    ): EventHandle;
    getActiveCategories(): SelectableCategory[];
}

Hierarchy (View Summary)

EventEmitter<CategoryAPI.Events>
- Facade

Implemented by

AssetActiveCategorySdkFacade

Index

Methods

activateCategory addEventListener getActiveCategories

Methods

activateCategory

activateCategory(
category: SelectableCategory,
): Result<void, "ERROR_CATEGORY_NOT_AVAILABLE">
Activates a category, rendering it in the UI. Only categories that are available can be activated.
Parameters
- category: SelectableCategory
  The category to activate.
Returns Result<void, "ERROR_CATEGORY_NOT_AVAILABLE">
A Result indicating success or failure.
- Defined in embedded/engine/src/lib/sdk/AssetCategoryFacade.ts:37

addEventListener

addEventListener<K extends "onActiveCategoryChange">(
event: K,
listener: (eventData: CategoryAPI.Events[K]) => void,
): EventHandle
Adds an event listener for a specific event.
Type Parameters
- K extends "onActiveCategoryChange"
  The type of the event key.
Parameters
- event: K
  The event to listen to.
- listener: (eventData: CategoryAPI.Events[K]) => void
  The callback function to be invoked when the event is emitted.
Returns EventHandle
An EventHandle with a remove method to unsubscribe the listener.
Inherited from EventEmitter.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:28

getActiveCategories

getActiveCategories(): SelectableCategory[]
Get a list of currently active categories.

Returns SelectableCategory[]
An array of active categories.
- Defined in embedded/engine/src/lib/sdk/AssetCategoryFacade.ts:44