Interface IChannelControls

Provides data transmission capabilities

Hierarchy

Properties

core? getOfflineSupport? identifier initialize isInitialized? priority processTelemetry setNextPlugin? teardown? update? version?

Methods

flush? pause? resume?

Properties

Optional core

core?: IAppInsightsCore<IConfiguration>

The App Insights core to use for backward compatibility. Therefore the interface will be able to access the core without needing to cast to "any". [optional] any 3rd party plugins which are already implementing this interface don't fail to compile.

Optional getOfflineSupport

getOfflineSupport?: (() => IInternalOfflineSupport)

Type declaration

Readonly identifier

identifier: string

Extension name

initialize

initialize: ((config, core, extensions, pluginChain?) => void)

Type declaration

    • (config, core, extensions, pluginChain?): void

    • Initialize plugin loaded by SDK

      Parameters

      • config: IConfiguration

        The config for the plugin to use

      • core: IAppInsightsCore<IConfiguration>

        The current App Insights core to use for initializing this plugin instance

      • extensions: IPlugin[]

        The complete set of extensions to be used for initializing the plugin

      • Optional pluginChain: ITelemetryPluginChain

        [Optional] specifies the current plugin chain which identifies the set of plugins and the order they should be executed for the current request.

      Returns void

Optional isInitialized

isInitialized?: (() => boolean)

Type declaration

    • (): boolean

    • Returns a value that indicates whether the plugin has already been previously initialized. New plugins should implement this method to avoid being initialized more than once.

      Returns boolean

Readonly priority

priority: number

Priority of the extension

processTelemetry

processTelemetry: ((env, itemCtx?) => void)

Type declaration

    • (env, itemCtx?): void

    • Call back for telemetry processing before it it is sent

      Parameters

      • env: ITelemetryItem

        This is the current event being reported

      • Optional itemCtx: IProcessTelemetryContext

        This is the context for the current request, ITelemetryPlugin instances can optionally use this to access the current core instance or define / pass additional information to later plugins (vs appending items to the telemetry item)

      Returns void

Optional setNextPlugin

setNextPlugin?: ((next) => void)

Type declaration

    • (next): void

    • Set next extension for telemetry processing, this is not optional as plugins should use the processNext() function of the passed IProcessTelemetryContext instead. It is being kept for now for backward compatibility only.

      Parameters

      Returns void

Optional teardown

teardown?: ((unloadCtx?, unloadState?) => boolean | void)

Type declaration

    • (unloadCtx?, unloadState?): boolean | 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.

      Parameters

      • Optional unloadCtx: IProcessTelemetryUnloadContext

        This is the context that should be used during unloading.

      • Optional unloadState: ITelemetryUnloadState

        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 | void

      boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.

Optional update

update?: ((updateCtx, updateState) => boolean | void)

Type declaration

    • (updateCtx, updateState): boolean | void

    • The the plugin should re-evaluate configuration and update any cached configuration settings or plugins. If implemented this method will be called whenever a plugin is added or removed and if the configuration has bee updated.

      Parameters

      • updateCtx: IProcessTelemetryUpdateContext

        This is the context that should be used during updating.

      • updateState: ITelemetryUpdateState

        The details / state of the update process, it holds details like the current and previous configuration.

      Returns boolean | void

      boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.

Optional Readonly version

version?: string

Plugin version (available in data.properties.version in common schema)

Methods

Optional flush

  • Flush to send data immediately; channel should default to sending data asynchronously. If executing asynchronously and you DO NOT pass a callback function then a IPromise will be returned which will resolve once the flush is complete. The actual implementation of the IPromise will be a native Promise (if supported) or the default as supplied by ts-async library

    Parameters

    • async: boolean

      send data asynchronously when true

    • Optional callBack: ((flushComplete?) => void)

      if specified, notify caller when send is complete, the channel should return true to indicate to the caller that it will be called. If the caller doesn't return true the caller should assume that it may never be called.

        • (flushComplete?): void

        • Parameters

          • Optional flushComplete: boolean

          Returns void

    • Optional sendReason: SendRequestReason

      specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified

    Returns boolean | void | IPromise<boolean>

    • If a callback is provided true to indicate that callback will be called after the flush is complete otherwise the caller should assume that any provided callback will never be called, Nothing or if occurring asynchronously a IPromise which will be resolved once the unload is complete, the IPromise will only be returned when no callback is provided and async is true.

Optional pause

  • Pause sending data

    Returns void

Optional resume

  • Resume sending data

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc