Skip to main content

LensStudio:AssetLibrary.AssetListRequest

Class

A request object for finding assets in the Asset Library.

Index

Example

// AssetListRequest bundles an EnvironmentSetting and an AssetFilter
// into a single request for querying the asset library service.
const { AssetFilter, AssetListRequest, EnvironmentSetting, Environment, Space } = await import('LensStudio:AssetLibrary');

const envSetting = new EnvironmentSetting();
envSetting.environment = Environment.Production;
envSetting.space = Space.Public;

const filter = new AssetFilter();
filter.searchText = 'sunglasses';

const request = new AssetListRequest(envSetting, filter);
console.log('Request environment:', request.environmentSetting.environment);
console.log('Request search text:', request.assetFilter.searchText);

Constructors

Constructor

new AssetListRequest(environmentSetting, assetFilter): AssetListRequest

Creates a new AssetListRequest for querying the Asset Library.

Parameters

ParameterType
environmentSettingEnvironmentSetting
assetFilterAssetFilter

Returns

AssetListRequest

Properties

assetFilter

readonly assetFilter: AssetFilter

Filter criteria used to narrow down the list of assets to retrieve.


environmentSetting

readonly environmentSetting: EnvironmentSetting

Environment setting that determines which asset environment context to query.

See also

"LensStudio:AssetLibrary".Asset.