Class CoreService

Base class for background plugins that run without a UI, managed by the plugin system via start/stop lifecycle.

Hierarchy (View Summary)

IPlugin
- CoreService

Index

Constructors

Properties

id pluginSystem

Methods

getTypeName isOfType isSame start stop

Constructors

constructor

new CoreService(
pluginSystem: PluginSystem,
descriptor?: Descriptor,
): CoreService
Constructs a new CoreService instance, serving as the base class for background plugin services that integrate with the Lens Studio plugin system.
Parameters
- pluginSystem: PluginSystem
- Optionaldescriptor: Descriptor
Returns CoreService
Overrides IPlugin.constructor

Properties

`Readonly`id

id: string

`Readonly`pluginSystem

pluginSystem: PluginSystem

The plugin system instance used to find and access registered interfaces.

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from IPlugin.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from IPlugin.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from IPlugin.isSame

start

start(): void
Initialize the service, set up event connections, and begin background operations.

Returns void

stop

stop(): void
Tear down event connections and stop all background operations.

Returns void