Interface INotificationListener

An interface used for the notification listener.

Hierarchy

  • INotificationListener

Properties

eventsDiscarded?: ((events, reason) => void)

Type declaration

    • (events, reason): void
    • [Optional] A function called when events are discarded.

      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

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

Type declaration

    • (sendReason, isAsync?): void
    • [Optional] A function called when the events have been requested to be sent to the sever.

      Parameters

      • sendReason: number

        The reason why the event batch is being sent.

      • Optional isAsync: boolean

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

      Returns void

eventsSent?: ((events) => void)

Type declaration

    • (events): void
    • [Optional] A function called when events are sent.

      Parameters

      Returns void

perfEvent?: ((perfEvent) => void)

Type declaration

    • (perfEvent): 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.

      Parameters

      Returns void

Methods

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

    Parameters

    • Optional isAsync: 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.

Generated using TypeDoc