Interface INotificationListener

An interface used for the notification listener.

Interface

interface INotificationListener {
    eventsDiscarded?: ((events: ITelemetryItem[], reason: number) => void);
    eventsSendRequest?: ((sendReason: number, isAsync?: boolean) => void);
    eventsSent?: ((events: ITelemetryItem[]) => void);
    offlineBatchDrop?(cnt: number, reason?: number): void;
    offlineBatchSent?(batch: IPayloadData): void;
    offlineEventsStored?(events: ITelemetryItem[]): void;
    perfEvent?: ((perfEvent: IPerfEvent) => void);
    unload?(isAsync?: boolean): void | IPromise<void>;
}

Properties

eventsDiscarded? eventsSendRequest? eventsSent? perfEvent?

Methods

offlineBatchDrop? offlineBatchSent? offlineEventsStored? unload?

Properties

OptionaleventsDiscarded

eventsDiscarded?: ((events: ITelemetryItem[], reason: number) => void)

[Optional] A function called when events are discarded.

Type declaration

    • (events, reason): void

    • Parameters

      • events: ITelemetryItem[]

        The array of events that have been discarded.

      • reason: number

        The reason for discarding the events. The EventsDiscardedReason constant should be used to check the different values.

      Returns void

OptionaleventsSendRequest

eventsSendRequest?: ((sendReason: number, isAsync?: boolean) => void)

[Optional] A function called when the events have been requested to be sent to the sever.

Type declaration

    • (sendReason, isAsync?): void

    • Parameters

      • sendReason: number

        The reason why the event batch is being sent.

      • OptionalisAsync: boolean

        A flag which identifies whether the requests are being sent in an async or sync manner.

      Returns void

OptionaleventsSent

eventsSent?: ((events: ITelemetryItem[]) => void)

[Optional] A function called when events are sent.

Type declaration

    • (events): void

    • Parameters

      Returns void

OptionalperfEvent

perfEvent?: ((perfEvent: IPerfEvent) => void)

[Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging the event can be displayed via the debug plugin extension.

Type declaration

    • (perfEvent): void

    • Parameters

      • perfEvent: IPerfEvent

        The performance event object

      Returns void

Methods

OptionalofflineBatchDrop

  • offlineBatchDrop(cnt, reason?): void

  • [Optional] A function called when the offline events have been dropped from the persistent storage

    Parameters

    • cnt: number

      count of batches dropped

    • Optionalreason: number

      the reason why the batches is dropped

    Returns void

    Since

    v3.1.1

OptionalofflineBatchSent

  • offlineBatchSent(batch): void

  • [Optional] A function called when the offline events have been sent from the persistent storage

    Parameters

    • batch: IPayloadData

      payload data that is sent from the persistent storage

    Returns void

    Since

    v3.1.1

OptionalofflineEventsStored

  • offlineEventsStored(events): void

  • [Optional] A function called when the offline events have been stored to the persistent storage

    Parameters

    • events: ITelemetryItem[]

      items that are stored in the persistent storage

    Returns void

    Since

    v3.1.1

Optionalunload

  • unload(isAsync?): void | IPromise<void>

  • Unload and remove any state that this INotificationListener may be holding, this is generally called when the owning Manager is being unloaded.

    Parameters

    • OptionalisAsync: boolean

      Can the unload be performed asynchronously (default)

    Returns void | IPromise<void>

    If the unload occurs synchronously then nothing should be returned, if happening asynchronously then the function should return an IPromise / Promise to allow any listeners to wait for the operation to complete.

Settings

Member Visibility

On This Page

Properties
Methods