Skip to main content

LensStudio:Logger.IUserLogCollector

Class

Plugin component interface for collecting and exposing user log data.

Index

Example

// IUserLogCollector extends IPluginComponent and provides the
// onRevealLogRequest signal for navigating to specific log entries.
const { IUserLogCollector } = await import('LensStudio:Logger');
const collector = this.pluginSystem.findInterface(
IUserLogCollector.interfaceId
) as import('LensStudio:Logger').IUserLogCollector;

if (!Editor.isNull(collector)) {
console.log('IUserLogCollector found');
this.connections.push(
collector.onRevealLogRequest.connect((logId: string) => {
console.log('User requested to reveal log entry:', logId);
})
);
}

Extends

Properties

interfaceId

static interfaceId: InterfaceId

Unique identifier for the IUserLogCollector interface.


onRevealLogRequest

readonly onRevealLogRequest: signal1<string, void>

Signal fired when a log reveal is requested, providing the associated log string.

Methods

getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

IPluginComponent.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

IPluginComponent.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

IPluginComponent.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

IPluginComponent.isSame