Skip to main content

IPluginDescriptor

Class

Descriptor exposing a plugin's id, name, description, dependencies, and exported interfaces.

Index

Example

// IPluginDescriptor exposes metadata about a registered plugin.
// Properties:
// id (readonly string) — unique plugin identifier
// name (readonly string) — human-readable name
// description (readonly string) — short description
// dependencies (readonly InterfaceId[]) — interfaces the plugin requires
// interfaces (readonly InterfaceId[]) — interfaces the plugin provides

const descriptors = this.pluginSystem.descriptors;
const count = Math.min(descriptors.length, 5);
console.log(`Total registered plugin descriptors: ${descriptors.length}`);
for (let i = 0; i < count; i++) {
const desc = descriptors[i];
console.log(` [${i}] id=${desc.id}, name=${desc.name}`);
}

Extends

Extended by

Properties

dependencies

readonly dependencies: InterfaceId[]

List of interface IDs that this plugin depends on.


description

readonly description: string

Human-readable description of the plugin.


id

readonly id: string

Unique identifier string for the plugin.


intendedPlatforms

readonly intendedPlatforms: TargetPlatform[]

Array of target platforms (Snapchat, Spectacles) where the plugin described by this descriptor is intended to run.


interfaces

readonly interfaces: InterfaceId[]

List of interface IDs that this plugin implements or exposes.


name

readonly name: string

Display name of the plugin.

Methods

getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame