Class AnalyticsPlugin

Analytics Plugin Implementation

Implements

Index

Constructors

Methods

onLoad onEnable onDisable onUnload processMessage onConversationCreate onConversationUpdate onConversationDelete trackEvent processAnalytics generateReport

Properties

metadata defaultConfig configSchema

Constructors

constructor

new AnalyticsPlugin(): AnalyticsPlugin
Returns AnalyticsPlugin

Methods

onLoad

onLoad(context: PluginContext): Promise<void>
Plugin lifecycle hooks
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onLoad
- Defined in plugins/examples/AnalyticsPlugin.ts:121

onEnable

onEnable(context: PluginContext): Promise<void>
Called when plugin is enabled
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onEnable
- Defined in plugins/examples/AnalyticsPlugin.ts:131

onDisable

onDisable(context: PluginContext): Promise<void>
Called when plugin is disabled
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onDisable
- Defined in plugins/examples/AnalyticsPlugin.ts:148

onUnload

onUnload(context: PluginContext): Promise<void>
Called when plugin is unloaded
Parameters
- context: PluginContext
Returns Promise<void>
Implementation of Plugin.onUnload
- Defined in plugins/examples/AnalyticsPlugin.ts:168

processMessage

processMessage(
message: EnhancedUIMessage,
context: PluginContext,
): Promise<EnhancedUIMessage>
Message tracking
Parameters
- message: EnhancedUIMessage
- context: PluginContext
Returns Promise<EnhancedUIMessage>
Implementation of MessagePlugin.processMessage
- Defined in plugins/examples/AnalyticsPlugin.ts:181

onConversationCreate

onConversationCreate(
conversation: Conversation,
context: PluginContext,
): Promise<Conversation>
Conversation tracking
Parameters
- conversation: Conversation
- context: PluginContext
Returns Promise<Conversation>
Implementation of ConversationPlugin.onConversationCreate
- Defined in plugins/examples/AnalyticsPlugin.ts:221

onConversationUpdate

onConversationUpdate(
conversation: Conversation,
context: PluginContext,
): Promise<Conversation>
Process conversation update
Parameters
- conversation: Conversation
- context: PluginContext
Returns Promise<Conversation>
Implementation of ConversationPlugin.onConversationUpdate
- Defined in plugins/examples/AnalyticsPlugin.ts:252

onConversationDelete

onConversationDelete(
conversationId: string,
context: PluginContext,
): Promise<void>
Process conversation deletion
Parameters
- conversationId: string
- context: PluginContext
Returns Promise<void>
Implementation of ConversationPlugin.onConversationDelete
- Defined in plugins/examples/AnalyticsPlugin.ts:280

trackEvent

trackEvent(event: AnalyticsEvent, context: PluginContext): Promise<void>
Analytics interface implementation
Parameters
- event: AnalyticsEvent
- context: PluginContext
Returns Promise<void>
Implementation of IAnalyticsPlugin.trackEvent
- Defined in plugins/examples/AnalyticsPlugin.ts:304

processAnalytics

processAnalytics(
data: AnalyticsData,
context: PluginContext,
): Promise<AnalyticsData>
Process analytics data
Parameters
- data: AnalyticsData
- context: PluginContext
Returns Promise<AnalyticsData>
Implementation of IAnalyticsPlugin.processAnalytics
- Defined in plugins/examples/AnalyticsPlugin.ts:323

generateReport

generateReport(type: string, options: any, context: PluginContext): Promise<any>
Generate custom reports
Parameters
- type: string
- options: any
- context: PluginContext
Returns Promise<any>
Implementation of IAnalyticsPlugin.generateReport
- Defined in plugins/examples/AnalyticsPlugin.ts:354

Properties

metadata

metadata: {
    id: string;
    name: string;
    version: string;
    description: string;
    author: { name: string; email: string };
    keywords: string[];
    license: string;
} = ...

Plugin metadata

defaultConfig

defaultConfig: { enabled: boolean; priority: number; options: AnalyticsConfig } = ...

Default plugin configuration

configSchema

configSchema: {
    type: string;
    required: string[];
    properties: {
        trackMessages: { type: string };
        trackConversations: { type: string };
        trackPerformance: { type: string };
        trackUserBehavior: { type: string };
        dataRetentionDays: { type: string; minimum: number; maximum: number };
        batchSize: { type: string; minimum: number; maximum: number };
        flushInterval: { type: string; minimum: number; maximum: number };
    };
} = ...

Plugin configuration schema

Class AnalyticsPlugin

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Returns AnalyticsPlugin

Methods

onLoad

Parameters

Returns Promise<void>

onEnable

Parameters

Returns Promise<void>

onDisable

Parameters

Returns Promise<void>

onUnload

Parameters

Returns Promise<void>

processMessage

Parameters

Returns Promise<EnhancedUIMessage>

onConversationCreate

Parameters

Returns Promise<Conversation>

onConversationUpdate

Parameters

Returns Promise<Conversation>

onConversationDelete

Parameters

Returns Promise<void>

trackEvent

Parameters

Returns Promise<void>

processAnalytics

Parameters

Returns Promise<AnalyticsData>

generateReport

Parameters

Returns Promise<any>

Properties

metadata

defaultConfig

configSchema

Settings

On This Page