Update docs comment for start/stoptrackpage

2026-10-05 15:27:05 +00:00 · 2018-11-30 14:03:07 -08:00
parent b6dd34bfde
commit 30a14bb78e
1 changed files with 5 additions and 3 deletions
@@ -670,13 +670,15 @@ declare module Microsoft.ApplicationInsights {
        context: ITelemetryContext;
        queue: Array<() => void>;
        /**
-         * Starts timing how long the user views a page or other item. Call this when the page opens.
-         * This method doesn't send any telemetry. Call {@link stopTrackTelemetry} to log the page when it closes.
+         * Starts the timer for tracking a page load time. Use this instead of `trackPageView` if you want to control when the page view timer starts and stops,
+         * but don't want to calculate the duration yourself. This method doesn't send any telemetry. Call `stopTrackPage` to log the end of the page view
+         * and send the event.
         * @param   name  A string that idenfities this item, unique within this HTML document. Defaults to the document title.
         */
        startTrackPage(name?: string): any;
        /**
-         * Logs how long a page or other item was visible, after {@link startTrackPage}. Call this when the page closes.
+         * Stops the timer that was started by calling `startTrackPage` and sends the pageview load time telemetry with the specified properties and measurements.
+         * The duration of the page view will be the time between calling `startTrackPage` and `stopTrackPage`.
         * @param   name  The string you used as the name in startTrackPage. Defaults to the document title.
         * @param   url   String - a relative or absolute URL that identifies the page or other item. Defaults to the window location.
         * @param   properties  map[string, string] - additional data used to filter pages and metrics in the portal. Defaults to empty.