LensStudio:PluginVerifier.Descriptor
ClassMetadata descriptor for a plugin verifier, including identity fields and a canVerify predicate that selects which plugins to test.
Index
Properties
Methods
Example
// PluginVerifier.Descriptor extends BaseDescriptor and adds canVerify,
// a callback that determines which plugins this verifier targets.
const d = new Descriptor();
d.id = 'com.docs.PluginVerifierDescriptorExample';
d.name = 'Plugin Verifier Example';
d.canVerify = (desc: IPluginDescriptor) => {
return desc.id.startsWith('com.example.');
};
Extends
Constructors
Constructor
new Descriptor():
Descriptor
Creates a new verifier descriptor instance for configuring plugin verifier metadata.
Returns
Descriptor
Overrides
BaseDescriptor.constructor
Properties
canVerify
canVerify: (
arg1) =>any
Function that returns true if this verifier should run for the given plugin descriptor.
Parameters
| Parameter | Type |
|---|---|
arg1 | IPluginDescriptor |
Returns
any
dependencies
dependencies:
InterfaceId[]
Array of interface IDs that this plugin requires to function.
Inherited from
description
description:
string
Human-readable description of the plugin shown in the plugin manager.
Inherited from
id
id:
string
Unique identifier for the plugin, typically in reverse domain notation.
Inherited from
intendedPlatforms
intendedPlatforms:
TargetPlatform[]
Array of target platforms (Snapchat, Spectacles) where this plugin is intended to run.
Inherited from
BaseDescriptor.intendedPlatforms
interfaces
interfaces:
InterfaceId[]
Array of interface IDs that this plugin provides or implements.
Inherited from
name
name:
string
Display name of the plugin.
Inherited from
Methods
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean