Interface

IAssetLinkPlugin

IAssetLinkPlugin

Methods

# static onLoad(handle, assetLink)

Called when a plugin is first loaded.

Parameters:
Name Type Description
handle IAssetLinkPluginHandle

An object which is used to tell Asset Link what functionality this plugin provides.

assetLink IAssetLink

The asset link instance.

View Source assetlink-plugin-api/src/IAssetLinkPlugin.js, line 9

# static searchAssets(assetLink, searchRequest, searchPhase)

Called (possibly twice) as part of each search request.

Parameters:
Name Type Description
assetLink IAssetLink

The asset link instance.

searchRequest Object

An object with varying structure produced by a search method plugin.

searchPhase String

One of "local" or "remote" to indicate whether the current search phase should use assetLink.entitySource.cache or assetLink.entitySource for a offline or and online asset search respectively.

View Source assetlink-plugin-api/src/IAssetLinkPlugin.js, line 21