Class AssetActiveCategorySdkFacade

Allows for management of active categories (aka artifacts).

Hierarchy (View Summary)

EventEmitterBase<CategoryAPI.Events>
- AssetActiveCategorySdkFacade

Implements

CategoryAPI.Facade

Index

Constructors

Properties

Methods

activateCategory addEventListener getActiveCategories

Constructors

constructor

new AssetActiveCategorySdkFacade(
plugin: AssetActiveCategoryRendererPlugin,
): AssetActiveCategorySdkFacade
Parameters
- plugin: AssetActiveCategoryRendererPlugin
  The plugin that provides the functionality for managing active categories.
Returns AssetActiveCategorySdkFacade
Overrides EventEmitterBase.constructor
- Defined in asset/category-select/src/lib/external-facade/AssetActiveCategorySdkFacade.ts:15

Properties

`Protected` `Readonly`emitter

emitter: Emitter<CategoryAPI.Events> = ...

An event emitter for handling custom events.

Methods

activateCategory

activateCategory(
category: UserSelectableCategory,
): Result<void, "ERROR_CATEGORY_NOT_AVAILABLE">
Activates a category, rendering it in the UI. Only categories that are available can be activated.
Parameters
- category: UserSelectableCategory
  The category to activate.
Returns Result<void, "ERROR_CATEGORY_NOT_AVAILABLE">
A Result indicating success or failure.
Implementation of Facade.activateCategory
- Defined in asset/category-select/src/lib/external-facade/AssetActiveCategorySdkFacade.ts:28

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.
Implementation of Facade.addEventListener
Inherited from EventEmitterBase.addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:76

getActiveCategories

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

Returns UserSelectableCategory[]
An array of active categories.
Implementation of Facade.getActiveCategories
- Defined in asset/category-select/src/lib/external-facade/AssetActiveCategorySdkFacade.ts:40