@microsoft/applicationinsights-teechannel-js 3.0.0-beta.2304-07

package/types/applicationinsights-teechannel-js.namespaced.d.ts

@@ -0,0 +1,96 @@
+/*
+ * Microsoft Application Insights JavaScript SDK Tee Channel, 3.0.0-beta.2304-07
+ * Copyright (c) Microsoft and contributors. All rights reserved.
+ *
+ * Microsoft Application Insights Team
+ * https://github.com/microsoft/ApplicationInsights-JS#readme
+ */
+
+declare namespace ApplicationInsights {
+    import { BaseTelemetryPlugin } from '@microsoft/applicationinsights-core-js';
+    import { IAppInsightsCore } from '@microsoft/applicationinsights-core-js';
+    import { IChannelControls } from '@microsoft/applicationinsights-core-js';
+    import { IChannelControlsHost } from '@microsoft/applicationinsights-core-js';
+    import { IConfig } from '@microsoft/applicationinsights-common';
+    import { IConfiguration } from '@microsoft/applicationinsights-core-js';
+    import { IPlugin } from '@microsoft/applicationinsights-core-js';
+    import { IProcessTelemetryContext } from '@microsoft/applicationinsights-core-js';
+    import { IProcessTelemetryUnloadContext } from '@microsoft/applicationinsights-core-js';
+    import { IProcessTelemetryUpdateContext } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryItem } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryPluginChain } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryUnloadState } from '@microsoft/applicationinsights-core-js';
+    import { ITelemetryUpdateState } from '@microsoft/applicationinsights-core-js';
+
+    interface ITeeChannelConfig {
+        /**
+         * Channel queues that is setup by caller in desired order.
+         * If channels are provided here, core will ignore any channels that are already setup, example if there is a SKU with an initialized channel
+         */
+        teeChannels?: IChannelControls[][];
+        /**
+         * By default the TeeChannel will use the core configuration `channels` (starting at index 1 `channels[1.xxx]`) as separate tee'd channel chains
+         * for processing events. This configuration allow you to ignore any additional core channels and only use the `teeChannels`
+         * Defaults to false
+         */
+        ignoreCoreChannels?: boolean;
+    }
+
+    class TeeChannel extends BaseTelemetryPlugin implements IChannelControlsHost {
+        readonly identifier: string;
+        readonly priority: number;
+        /**
+         * Returns whether the plugin has been initialized
+         */
+        isInitialized: () => boolean;
+        constructor();
+        initialize(config: IConfiguration & IConfig, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain): void;
+        getTeeChannels(): IChannelControls[][];
+        processTelemetry(telemetryItem: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+        /**
+         * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
+         * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
+         * processTelemetry calls are ignored and it just calls the processNext() with the provided context.
+         * @param unloadCtx - This is the context that should be used during unloading.
+         * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
+         * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
+         */
+        teardown(unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState): void | boolean;
+        /**
+         * The the plugin should re-evaluate configuration and update any cached configuration settings.
+         * @param updateCtx - This is the context that should be used during updating.
+         * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
+         * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.
+         */
+        update(updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState): void | boolean;
+        /**
+         * Pause the sending (transmission) of events, this will cause all events to be batched only until the maximum limits are
+         * hit at which point new events are dropped. Will also cause events to NOT be sent during page unload, so if Session storage
+         * is disabled events will be lost.
+         * SessionStorage Limit is 2000 events, In-Memory (Array) Storage is 10,000 events (can be configured via the eventsLimitInMem).
+         */
+        pause(): void;
+        /**
+         * Resume the sending (transmission) of events, this will restart the timer and any batched events will be sent using the normal
+         * send interval.
+         */
+        resume(): void;
+        /**
+         * Flush the batched events immediately (not synchronously).
+         * Will not flush if the Sender has been paused.
+         */
+        flush(): void;
+        /**
+         * Flush the batched events synchronously (if possible -- based on configuration).
+         * Will not flush if the Send has been paused.
+         */
+        onunloadFlush(): void;
+        /**
+         * Get and return the named channel instance (if present) from the queues
+         * @param pluginIdentifier - The identifier name of the plugin
+         */
+        getChannel<T extends IPlugin = IPlugin>(pluginIdentifier: string): T;
+    }
+
+    
+}