@dynatrace/dtrum-api-types
Advanced tools
Comparing version 1.221.12 to 1.223.5
357
dtrum.d.ts
| /** | ||
| * Signature of the function passed as callback in [[addLeaveActionListener]] | ||
| * Signature of the function passed as callback in {@link addLeaveActionListener} | ||
| * | ||
| * @param actionId the id for which the leave is called | ||
| * @param actionId the ID for which the leave is called | ||
| * @param stoptime start resp. endtime of the action | ||
| * @param isRootAction true if the action with the provided id is a root action | ||
| * @param isRootAction true if the action with the provided ID is a root action | ||
| */ | ||
@@ -13,7 +13,7 @@ export interface ActionLeaveListener { | ||
| /** | ||
| * Signature of the function passed as callback in [[addEnterActionListener]] | ||
| * Signature of the function passed as callback in {@link addEnterActionListener} | ||
| * | ||
| * @param actionId the id for which the enter is called | ||
| * @param actionId the ID for which the enter is called | ||
| * @param starttime start resp. endtime of the action | ||
| * @param isRootAction true if the action with the provided id is a root action | ||
| * @param isRootAction true if the action with the provided ID is a root action | ||
| * @param [element] the element which resulted in the initiation of the event | ||
@@ -106,7 +106,7 @@ */ | ||
| SUCCESS = 0, | ||
| /** The action with the provided id was not found, or there was no currently active action */ | ||
| /** The action with the provided ID was not found, or there was no currently active action */ | ||
| ACTION_NOT_FOUND = 1, | ||
| /** The provided action name was not of type string */ | ||
| INVALID_ACTION_NAME = 2, | ||
| /** The provided action id was provided, not of type number */ | ||
| /** The provided action ID was provided, not of type number */ | ||
| INVALID_ACTION_ID = 3 | ||
@@ -117,10 +117,13 @@ } | ||
| /** | ||
| * Enables/disables automatic action detection. | ||
| * Enables/disables automatic action detection. Use when you want to instrument your application only manually. | ||
| * | ||
| * @param enabled whether automatic action detection should be enabled or disabled | ||
| * @see {@link enterAction} | ||
| * @see {@link leaveAction} | ||
| * @param enabled Whether automatic action detection should be enabled or disabled | ||
| */ | ||
| setAutomaticActionDetection(enabled: boolean): void; | ||
| /** | ||
| * Tells the js agent to not automatically detect load end. Load start and load end must be set explicitly via signalLoadEnd. | ||
| * This function must be called immediately after the js agent script tag! | ||
| * Tells the RUM monitoring code to not automatically detect the load end event. | ||
| * The load end event must be set explicitly via {@link signalLoadEnd}. | ||
| * Needs to be called immediately after the RUM monitoring code is injected! | ||
| * | ||
@@ -130,12 +133,15 @@ */ | ||
| /** | ||
| * Signals that the page has finished loading | ||
| * Signals that the page has finished loading. | ||
| * Use in combination with {@link setLoadEndManually} to define your own load end times. | ||
| * | ||
| * @see {@link setLoadEndManually} | ||
| */ | ||
| signalLoadEnd(): void; | ||
| /** | ||
| * Reports the response code and an additional message for the current page to the server. | ||
| * Needs to be called before the onload event has finished, otherwise the information will be discarded | ||
| * Report the HTTP status code and a custom message for the response of the current page. | ||
| * For example, use to mark your 404 pages that respond with a HTTP status code of 200. | ||
| * Needs to be called before the onload event of the page has finished, otherwise the information will be discarded. | ||
| * | ||
| * @param responseCode The response code of the current page | ||
| * @param message an additional informational message | ||
| * @param responseCode Sets the HTTP status code | ||
| * @param message An additional informational message | ||
| * @returns false if the values were incorrect or the function has been called too late, true otherwise | ||
@@ -145,9 +151,11 @@ */ | ||
| /** | ||
| * Reports the response code and an additional message for the current xhr action | ||
| * Needs to be called before the xhr action is finished and all listeners have been invoked | ||
| * Reports the HTTP status code and an additional message for the response of the current XHR action. | ||
| * For example, use when the HTTP status code of your XHR response returns 200, while the result returned | ||
| * by the server indicates a failed request. | ||
| * Needs to be called before the XHR action is finished and all listeners have been invoked. | ||
| * | ||
| * @param responseCode The response code of the current xhr action | ||
| * @param message an additional informational message | ||
| * @param parentActionId the optional actionId of the action to mark as failed. If it is not present, the currently open | ||
| * action is used | ||
| * @param responseCode The response code of the current XHR action | ||
| * @param message An additional informational message | ||
| * @param parentActionId The optional ID of the action to mark as failed. If it is not present, | ||
| * the currently open action is used. | ||
| * @returns false if the values were incorrect or the function has been called too late, true otherwise | ||
@@ -157,4 +165,6 @@ */ | ||
| /** | ||
| * Force signal sending to make certain that actions aren't lost. | ||
| * Force signal sending to make sure that actions aren't lost (e.g., use before a window unload event). | ||
| * | ||
| * @deprecated Use {@link sendBeacon} instead. We will deprecate and remove sendSignal with June 2022. | ||
| * @see {@link sendBeacon} | ||
| * @param forceSync Force synchronous sending of signal (if false, it'll be sent asynchronously) | ||
@@ -166,17 +176,36 @@ * @param sendPreview Force sending of preview signals which haven't been closed yet. | ||
| /** | ||
| * Enter an action | ||
| * Forces beacon sending to make sure actions aren't lost. | ||
| * For example, use before a window unload event by adding a {@link addPageLeavingListener}. | ||
| * | ||
| * @param actionName name of the action | ||
| * @param actionType type of the action | ||
| * @param startTime timestamp in milliseconds. if null, current time is used. | ||
| * @param sourceUrl source url for the action | ||
| * @param sourceTitle source title for the action | ||
| * @returns id of the created action | ||
| * @see {@link addPageLeavingListener} | ||
| * @param forceSync Force synchronous sending of beacons. If false, the beacon will be sent asynchronously. | ||
| * @param sendPreview Force sending of preview beacons which haven't been closed yet. | ||
| * @param killUnfinished Kills unfinished actions and sends them immediately. Handle with care, actions might be inaccurate. | ||
| */ | ||
| sendBeacon(forceSync: boolean, sendPreview: boolean, killUnfinished: boolean): void; | ||
| /** | ||
| * Enters a new custom action. Use to set the load start event for a new custom action. | ||
| * Needs to be called before {@link leaveAction}, which closes the custom action. | ||
| * | ||
| * @see {@link leaveAction} | ||
| * @param actionName Name of the action | ||
| * @param actionType Type of the action (e.g., can be 'click', 'load', 'KD',...) - | ||
| * DEPRECATED: not used any more, will be removed in July 2022. | ||
| * @param startTime Timestamp in milliseconds. if null, current time is used. | ||
| * @param sourceUrl Source url for the action | ||
| * @param sourceTitle Source title for the action | ||
| * @returns ID of the created action | ||
| */ | ||
| "enterAction"(actionName: string, actionType: string, startTime?: number, sourceUrl?: string, sourceTitle?: string): number; | ||
| /** | ||
| * Attach a listener that gets called while entering an action <br /> | ||
| * Remove listener if not needed or make sure to filter actions out if using [[addActionProperties]], to prevent sending the same actionproperty for every action. See [[removeEnterActionListener]] | ||
| * Attaches a listener that gets called while entering an action <br /> | ||
| * Remove the listener if not needed or make sure to filter actions if using {@link addActionProperties}, | ||
| * to prevent sending the same action property for every action. | ||
| * Use to hook into automatic action creation event to influence related concepts like | ||
| * action naming or action properties. | ||
| * | ||
| * @param listener a function that will be called when entering an action | ||
| * @see {@link removeEnterActionListener} | ||
| * @see {@link actionName} | ||
| * @see {@link addActionProperties} | ||
| * @param listener A function that will be called when entering a new action | ||
| * @returns void | ||
@@ -186,5 +215,5 @@ */ | ||
| /** | ||
| * Remove an already attached enter action listener | ||
| * Removes a previously attached listener that detects the enter action event | ||
| * | ||
| * @param listener a listener to be removed | ||
| * @param listener The reference to the listener that needs to be removed | ||
| * @returns void | ||
@@ -194,17 +223,23 @@ */ | ||
| /** | ||
| * Leaves an action | ||
| * Leaves an action that has previously been created by an enterAction call. | ||
| * Use to set the load end event for a custom action and to complete its creation. | ||
| * Needs to be called after {@link enterAction}. | ||
| * | ||
| * @param actionId id of the action to leave. must be the value returned by enterAction | ||
| * @param stopTime timestamp in milliseconds | ||
| * @param startTime optional start time in milliseconds (necessary if start time should be modified). | ||
| * @see {@link enterAction} | ||
| * @param actionId ID of the action to leave. must be the value returned by enterAction | ||
| * @param stopTime Timestamp in milliseconds | ||
| * @param startTime Optional start time in milliseconds (necessary if start time should be modified). | ||
| * Note that, when providing a start time, it mustn't be longer than an hour in the past, otherwise the | ||
| * agent will ignore it. | ||
| * RUM monitoring code will ignore it. | ||
| */ | ||
| "leaveAction"(actionId: number, stopTime?: number, startTime?: number): void; | ||
| /** | ||
| * Attach a listener that gets called while leaving an action <br /> | ||
| * Remove listener if not needed or make sure to filter actions out if using [[addActionProperties]], | ||
| * to prevent sending the same actionproperty for every action. See [[removeLeaveActionListener]] | ||
| * Attaches a listener that gets called when leaving an action <br /> | ||
| * Remove the listener if not needed or make sure to filter actions if using {@link addActionProperties}, | ||
| * to prevent sending the same action property for every action. | ||
| * Use to hook into the out of the box action closing event. | ||
| * | ||
| * @param listener a function that will be called when leaving an action | ||
| * @see {@link removeLeaveActionListener} | ||
| * @see {@link addActionProperties} | ||
| * @param listener A function that will be called when leaving an action | ||
| * @returns void | ||
@@ -214,5 +249,5 @@ */ | ||
| /** | ||
| * Remove an already attached leave action listener | ||
| * Removes a previously attached listener that detects the leave action event | ||
| * | ||
| * @param listener a listener to be removed | ||
| * @param listener A leave action listener to be removed | ||
| * @returns void | ||
@@ -222,13 +257,13 @@ */ | ||
| /** | ||
| * Adds custom action properties to an ongoing action. <br /> | ||
| * Currently only accepts valid java long, java double (as a string representation), Date objects & short strings of at most 100 characters. <br /> | ||
| * NOTE: action properties need to have a lower case key! <br /> | ||
| * Similar to [[sendSessionProperties]] | ||
| * To see the action properties in the UI make sure to configure them correctly (Application Settings). | ||
| * https://www.dynatrace.com/support/help/how-to-use-dynatrace/real-user-monitoring/setup-and-configuration/web-applications/additional-configuration/define-user-action-and-session-properties/ | ||
| * Adds custom {@link https://www.dynatrace.com/support/help/shortlink/user-session-properties | action properties} | ||
| * to the currently active action. <br /> | ||
| * Only accepts valid java long, java double (as a string representation), Date objects, and | ||
| * short strings with a maximum length of 100 characters. <br /> | ||
| * Action properties must be defined first under Application settings and use a lower case key. | ||
| * | ||
| * @param parentActionId id of the action. | ||
| * @see {@link sendSessionProperties} | ||
| * @param parentActionId ID of the action. | ||
| * @param javaLong JSON object containing key value pairs of valid numbers. <br /> Value should be between | ||
| * range -9223372036854776000 & 9223372036854776000 | ||
| * @param date JSON object containing key value pairs of JavaScript date objects.<br /> Value should be JavaScript Date object | ||
| * @param date JSON object containing key value pairs of JavaScript Date objects.<br /> Value should be JavaScript Date object | ||
| * @param shortString JSON object containing key value pairs of strings.<br /> Value character count should be less | ||
@@ -239,7 +274,4 @@ * than 100 characters | ||
| * | ||
| * Each key value pair must be defined in the following format "key: { value: value<AllowedMapTypes>, public?: boolean } | ||
| * Each key value pair must be defined in the following format 'key: { value: value<AllowedMapTypes>, public?: boolean }' | ||
| * Public property is optional and if not declared as true values will be sent as masked(dT_pv) in doNotTrack mode | ||
| * | ||
| * LEGACY: You can still use the old way of sending properties as key: value pairs, like { string: "some string", anotherString: "another string" } | ||
| * But keep in mind that in doNotTrack mode those will always be masked by default | ||
| * @returns Status report about properties that were passed to the function. | ||
@@ -251,9 +283,12 @@ * It contains data about failed properties with the failure reason. | ||
| /** | ||
| * Reports an error message | ||
| * Reports an error object to Dynatrace. Use when you catch errors in your own application code | ||
| * but you also want to propagate them to Dynatrace instead of logging them yourself. | ||
| * If errors are handled by your own application code it will stop the error from being handled | ||
| * by the global JavaScript {@link https://developer.mozilla.org/en-US/docs/Web/API/GlobalEventHandlers/onerror | onerror event handler}, | ||
| * which is used by Dynatrace to automatically capture JavaScritp errors. | ||
| * | ||
| * @param error The error to be tracked. Any browser error object is supported, if error does not | ||
| * have a stacktrace, it will attempt to generate one. | ||
| * Alternatively you can create your own object to pass to this function, simply set the properties "message", | ||
| * "file", "line", "column" & "stack" to the corresponding values and dynatrace will pick up the values. All values | ||
| * except message are optional. | ||
| * @param error The error to be reported. Any browser error object is supported and if the error doesn't | ||
| * have a stacktrace the RUM JavaScipt monitoring code will attempt to generate one. | ||
| * Alternatively create your own object that has the following properties set: 'message', | ||
| * 'file', 'line', 'column', and 'stack'. The 'message' property must be provided; all other values are optional. | ||
| * @param parentActionId parent action id. if not passed or null, error is added to current action | ||
@@ -263,5 +298,6 @@ */ | ||
| /** | ||
| * Identifies a user | ||
| * Sets the {@link https://www.dynatrace.com/support/help/shortlink/user-tagging#user-tagging-via-javascript-api | user tag}. | ||
| * Use to identify individual users across different browsers, devices, and user sessions. | ||
| * | ||
| * @param value - The value to name the user (e.g. a username, a userid, an email address...) | ||
| * @param value The name of the user. For example, use a name, userid, or your user's email address. | ||
| */ | ||
@@ -272,14 +308,18 @@ identifyUser(value: string): void; | ||
| * | ||
| * @deprecated Since modern browsers already provide resource timings, including for third parties, | ||
| * we will deprecate and remove this function with June 2022. | ||
| * @param type 'i'...image, 's'...script, 'c'... custom | ||
| * @param url complete URL of resource | ||
| * @param url Complete URL of resource | ||
| */ | ||
| startThirdParty(type: ResourceSummaryTypes, url: string): void; | ||
| /** | ||
| * Indicates stop of a third party resource | ||
| * Indicates the stop of a third party resource | ||
| * | ||
| * @param url complete URL of resource (must match URL provided in startThirdParty) | ||
| * @param success true if the resource was loaded successfully, false if not | ||
| * @param start absolute start time in milliseconds. Optional. When parameter is not passed or <=0, | ||
| * @deprecated Since modern browsers already provide resource timings, including for third parties, | ||
| * we will deprecate and remove this function with June 2022. | ||
| * @param url Complete URL of resource (must match URL provided in startThirdParty) | ||
| * @param success True if the resource was loaded successfully, false if not | ||
| * @param start Absolute start time in milliseconds. Optional. When parameter is not passed or <=0, | ||
| * time of startThirdParty call is used | ||
| * @param stop absolute stop time in milliseconds. Optional. When parameter is not passed or <=0, | ||
| * @param stop Absolute stop time in milliseconds. Optional. When parameter is not passed or <=0, | ||
| * time of stopThirdParty call is used | ||
@@ -289,18 +329,20 @@ */ | ||
| /** | ||
| * Adds a listener that is called when the user is leaving the page, but before the monitor signal is sent | ||
| * Adds a listener that is called when the user is leaving the page, but before the RUM monitoring beacon is sent | ||
| * Use when you want to hook into the unload of the page. | ||
| * | ||
| * @param listener a function that will be called in case the user leaves the page | ||
| * @param listener A function that will be called in case the user leaves the page | ||
| */ | ||
| addPageLeavingListener(listener: PageLeaveListener): void; | ||
| /** | ||
| * Indicates the start of a user input. User inputs must always be stopped by calling endUserInput. | ||
| * Indicates the start of a user input. User inputs must always be stopped by calling {@link endUserInput}. | ||
| * If an XHR call or a page load happens, the RUM monitoring code checks if a user input is active. If so, that user input is | ||
| * set to have triggered the user action. | ||
| * Use when a user input is not automatically detected by the RUM monitoring code. | ||
| * | ||
| * If an XHR call or a page load happens, the agent checks if a user input is active. If so, that user input is | ||
| * set to have triggered the page action. | ||
| * | ||
| * @param domNode domnode which triggered the action (button, etc) is used for determining its caption | ||
| * @param type type of action: 'click', 'keypress', 'scroll',... | ||
| * @param addInfo additional info for user input such as key, mouse button, etc ('F5', 'RETURN',...) | ||
| * @param validTime how long this userInput should be valid(in ms) | ||
| * @returns an object containing all the information about the userInput | ||
| * @see {@link endUserInput} | ||
| * @param domNode DOM node which triggered the action (button, etc) is used for determining its caption | ||
| * @param type Type of action: 'click', 'keypress', 'scroll',... | ||
| * @param addInfo Additional info for user input such as key, mouse button, etc ('F5', 'RETURN',...) | ||
| * @param validTime How long this userInput should be valid(in ms) | ||
| * @returns An object containing all the information about the userInput | ||
| */ | ||
@@ -311,36 +353,46 @@ beginUserInput(domNode: HTMLElement, type: string, addInfo: string, validTime?: number): DtRumUserInput; | ||
| * | ||
| * @param userInputObject the user input object returned by beginUserInput | ||
| * @param userInputObject The user input object returned by {@link beginUserInput} | ||
| */ | ||
| endUserInput(userInputObject: DtRumUserInput): void; | ||
| /** | ||
| * Initiate ajax call | ||
| * Extends or initiates actions. | ||
| * Use when you want to extend an active Load or XHR action by another unlinked XHR call (i.e., action). | ||
| * This is particularly useful when the XHR call in question is asynchronous in nature | ||
| * and therefore can't automatically be correlated to an action, which otherwise | ||
| * would lead to the action being closed too early and inaccurate metrics measurements (e.g., user action duration). | ||
| * Needs to be called before {@link leaveXhrAction}. | ||
| * | ||
| * @param type optional additional info about type of xhr (eg framework name,etc) | ||
| * @param xmode xhr action creation mode | ||
| * 0 .. just extend running ajax actions | ||
| * 1 .. extend any running action | ||
| * 2 .. extend any running action - visible subaction | ||
| * 3 .. start action if user input is present | ||
| * @see {@link leaveXhrAction} | ||
| * @param type Optional additional info about type of XHR (e.g., framework name, etc.) | ||
| * @param xmode XHR action creation mode | ||
| * 0 ... Just extend running XHR actions | ||
| * 1 ... Extend any running action | ||
| * 2 ... Extend any running action - visible subaction - DEPRECATED: use 1 instead | ||
| * 3 ... Start action if user input is present | ||
| * @param xhrUrl url of the requested resource | ||
| * @returns id of the XhrAction | ||
| * @returns ID of the XhrAction | ||
| */ | ||
| enterXhrAction(type: string, xmode?: 0 | 1 | 2 | 3, xhrUrl?: string): number; | ||
| /** | ||
| * Indicates the end of an xhr action | ||
| * Indicates the end of an XHR action | ||
| * | ||
| * @param actionId id of the xhr Action | ||
| * @param [stopTime] The stop time of the xhr Action | ||
| * @param actionId ID of the XHR Action | ||
| * @param [stopTime] The stop time of the XHR Action | ||
| */ | ||
| leaveXhrAction(actionId: number, stopTime?: number): void; | ||
| /** | ||
| * Indicates that an xhr callback is active (eg. XMLHttpRequest onreadystatechange). This is necessary to automatically add | ||
| * actions started during a callback as subactions. Xhr callback must be stopped by endXhrCallback | ||
| * Indicates that an XHR callback is active (eg. XMLHttpRequest onreadystatechange) and relinks subsequently triggered XHR actions. | ||
| * For example, when an XHR callback adds a script tag to your page, any XHR call triggered by it | ||
| * would not be automatically added to the currently running action. | ||
| * Calling this function allows relinking to such a subsequent XHR call (i.e., XHR actions) to its initial action. | ||
| * The XHR callback must also be stopped by {@link leaveXhrCallback}. | ||
| * | ||
| * @param actionId id of the action where callback belongs to | ||
| * @param actionId ID of the action where callback belongs to | ||
| */ | ||
| enterXhrCallback(actionId: number): void; | ||
| /** | ||
| * Indicates the end of an xhr callback. | ||
| * Indicates the end of an XHR callback. | ||
| * | ||
| * @param actionId id of the action where callback belongs to | ||
| * @see {@link enterXhrCallback} | ||
| * @param actionId ID of the action where callback belongs to | ||
| */ | ||
@@ -350,3 +402,3 @@ leaveXhrCallback(actionId: number): void; | ||
| * Indicates the start of a load action. Frameworks often have their own load callback functions | ||
| * this can be used when framework starts load before "DOMContentLoaded" | ||
| * this can be used when framework starts load before 'DOMContentLoaded'. | ||
| * | ||
@@ -356,12 +408,16 @@ */ | ||
| /** | ||
| * Tells the JavaScript agent to wait for an additional call of signalOnLoadEnd. | ||
| * When the last call of signalOnLoadEnd is performed the "onload" action is closed. | ||
| * Note: if this function is called, signalOnLoadEnd MUST be called afterwards to indicated the end of one load. | ||
| * Signals that the load end event is provided manually. | ||
| * Use when you want to extend the onload duration (e.g. to encompass also the initialization of a framework) | ||
| * | ||
| * @see {@link setLoadEndManually} | ||
| * Notifies the RUM monitoring code to wait for an additional call of {@link signalOnLoadEnd}, before closing the 'onload' action. | ||
| * Note: Only when {@link signalOnLoadEnd} is called after, the load action will use the provided load end event correctly. | ||
| * | ||
| */ | ||
| incrementOnLoadEndMarkers(): void; | ||
| /** | ||
| * Indicates the end of a load action. needs incrementOnLoadEndMarkers to be called before. | ||
| * When last signalOnLoadEnd is called, the "onload" action is closed | ||
| * Indicates the end of a load action. needs {@link incrementOnLoadEndMarkers} to be called before. | ||
| * When the last {@link signalOnLoadEnd} is called, the action is closed. | ||
| * | ||
| * @see {@link signalOnLoadStart} | ||
| */ | ||
@@ -372,14 +428,14 @@ signalOnLoadEnd(): void; | ||
| * | ||
| * @param actionName the new name for the action | ||
| * @param actionId the action id of the action to update the name of | ||
| * @returns an {@see ActionNameResult} whether the process was successful | ||
| * @param actionName The new name of the action | ||
| * @param actionId The action ID of the to be updated action name | ||
| * @returns an {@link ActionNameResult} whether the process was successful | ||
| */ | ||
| actionName(actionName: string, actionId?: number): ActionNameResult; | ||
| /** | ||
| * Sends an endSession signal to the server, which will cause the session to end without waiting for a timeout | ||
| * | ||
| * Ends the currently active session immediately. | ||
| */ | ||
| endSession(): void; | ||
| /** | ||
| * Returns the current time in milliseconds. It automatically chooses the most accurate way to determine the current time. | ||
| * Returns the current time in milliseconds. | ||
| * It automatically chooses the most accurate way to determine the current time. | ||
| * | ||
@@ -390,14 +446,21 @@ * @returns the current time in milliseconds | ||
| /** | ||
| * Cookie Opt-In only: Enables the JavaScript agent in case it was disabled via Cookie Opt-In setting. | ||
| * Enables the RUM monitoring code in case it was initially disabled via the | ||
| * {@link https://www.dynatrace.com/support/help/shortlink/configure-rum-privacy#opt-in-mode | opt-in mode}. | ||
| * Use in combination with a user consent tool to enable RUM monitoring in case the consent has been provided. | ||
| * | ||
| * @see {@link disable} | ||
| */ | ||
| enable(): void; | ||
| /** | ||
| * Cookie Opt-In only: Disables the JavaScript agent and removes Dynatrace cookies for Cookie Opt-In | ||
| * mode in case dtrum.enable() has been called earlier | ||
| * Disables the RUM monitoring code and removes all cookies in case dtrum.enable() has been called earlier, | ||
| * enabling the {@link https://www.dynatrace.com/support/help/shortlink/configure-rum-privacy#opt-in-mode | opt-in mode}. | ||
| * Use in combination with a user consent tool to disable RUM monitoring in case the consent has not been provided. | ||
| * | ||
| * @see {@link enable} | ||
| */ | ||
| disable(): void; | ||
| /** | ||
| * Adds a listener to get triggered upon the creation of a new visit id | ||
| * Adds a listener that gets triggered when the current visit times out and before a new visit id is generted. | ||
| * | ||
| * @param listener the listener to add | ||
| * @param listener The listener to add | ||
| */ | ||
@@ -408,3 +471,3 @@ addVisitTimeoutListener(listener: (visitId: string, newVisitAfterTimeout: boolean) => void): void; | ||
| * | ||
| * @param ignoreCostControl allows to enable session replay despite cost control configuration | ||
| * @param ignoreCostControl Allows to enable session replay despite cost control configuration | ||
| */ | ||
@@ -417,5 +480,6 @@ enableSessionReplay(ignoreCostControl: boolean): void; | ||
| /** | ||
| * Get and evaluate meta-data for the page | ||
| * Get and evaluate meta-data for the page. | ||
| * Use to troubleshoot RUM monitoring. | ||
| * | ||
| * @returns array of metadata objects with configured ids, type, expression, and captured values | ||
| * @returns Array of metadata objects with configured ids, type, expression, and captured values | ||
| */ | ||
@@ -431,2 +495,3 @@ getAndEvaluateMetaData(): { | ||
| * Enables persistent values again. Only applies if 'disablePersistentValues' has been called previously. | ||
| * Use when you want to re-enable monitoring returning users. | ||
| */ | ||
@@ -436,6 +501,8 @@ enablePersistentValues(): void; | ||
| * Removes all traces of persistent values and disables all functionality that would | ||
| * recreate one. Note that this has to be called on every page, since it removes persistent agent data, including | ||
| * recreate one. Note that this has to be called on every page, since it removes persistent RUM monitoring data, including | ||
| * the information that persistent data shouldn't be stored. | ||
| * Use when you want to disable monitoring of returning users. | ||
| * Read more about {@link https://www.dynatrace.com/support/help/shortlink/cookies#cookie-storage | cookie storage}. | ||
| * | ||
| * @param remember if true, this configuration state is persisted in local storage, so that it doesn't | ||
| * @param remember If true, this configuration state is persisted in local storage, so that it doesn't | ||
| * reset on each page load | ||
@@ -445,17 +512,18 @@ */ | ||
| /** | ||
| * Adds method which will be called before diff action in session replay during recording. | ||
| * Registers a method which will be invoked before the 'diff' action in session replay during recording. | ||
| * | ||
| * @param method listener which will be called before diff action. Listener receives one argument | ||
| * @param method Listener which will be called before diff action. Listener receives one argument | ||
| * which is a string with diff. Listener also must return the diff string. | ||
| * Read more about {@link https://www.dynatrace.com/support/help/shortlink/cookies#cookie-storage | cookie storage}. | ||
| */ | ||
| registerPreDiffMethod(method: (diff: string) => string): void; | ||
| /** | ||
| * Sends session properties on a beacon signal | ||
| * currently only accepts valid java long, java double (as a string representation), Date objects & short strings of | ||
| * at most 100 characters. <br /> | ||
| * Sends {@link https://www.dynatrace.com/support/help/shortlink/user-session-properties | session properties} on a beacon | ||
| * currently only accepts valid java long, java double (as a string representation), Date objects, and short strings of | ||
| * a maximum length of 100 characters. <br /> | ||
| * NOTE: session properties need to have a lower case key! <br /> | ||
| * Similar to [[addActionProperties]] | ||
| * To see the session properties in the UI make sure to configure them correctly(Application Settings). | ||
| * https://www.dynatrace.com/support/help/how-to-use-dynatrace/real-user-monitoring/setup-and-configuration/web-applications/additional-configuration/define-user-action-and-session-properties/ | ||
| * | ||
| * Make sure to first define session properties under Application settings before making this API call. | ||
| * | ||
| * @see {@link addActionProperties} is related and works similarly. | ||
| * @param javaLongOrObject JSON object containing key value pairs of valid numbers. <br /> Value should be between range -9223372036854776000 & 9223372036854776000 | ||
@@ -468,7 +536,5 @@ * @param date JSON object containing key value pairs of JavaScript date objects.<br /> Value should be JavaScript Date object | ||
| * | ||
| * Each key value pair must be defined in the following format "key: { value: value<AllowedMapTypes>, public?: boolean } | ||
| * Each key value pair must be defined in the following format 'key: { value: value<AllowedMapTypes>, public?: boolean }' | ||
| * Public property is optional and if not declared as true values will be sent as masked(dT_pv) in doNotTrack mode | ||
| * | ||
| * LEGACY: You can still use the old way of sending properties as key: value pairs, like { string: "some string", anotherString: "another string" } | ||
| * But keep in mind that in doNotTrack mode those will always be masked by default | ||
| * @returns Status report about properties that were passed to the function. | ||
@@ -484,12 +550,13 @@ * It contains data about failed properties with the failure reason. | ||
| ): PropertiesSendingReport | void; | ||
| /** | ||
| * sends a custom error with key and value as metadata | ||
| * Report your own{@link https://www.dynatrace.com/support/help/shortlink/configure-application-errors#configure-custom-errors | custom errors}. | ||
| * For example, use when you want to capture form validation errors in your signup process. | ||
| * Custom errors must first be defined in the Application settings. | ||
| * | ||
| * @param key - the key of the error, e.g. 'validation error' | ||
| * @param value - the error value, e.g. 'Email validation failed' | ||
| * @param hint - a hint to pinpoint the problem, e.g. content of the input element which triggered the failed validation | ||
| * @param parentingInfo - how the custom error should be attached (default = false), | ||
| * [case number]: to which open action the custom error event should be attached, | ||
| * [case boolean]: if true it will get attached to the current active action | ||
| * @param key The key of the error. For example, 'validation error' | ||
| * @param value The error value. For example, 'Email validation failed' | ||
| * @param hint A hint to pinpoint the problem, e.g. content of the input element which triggered the failed validation | ||
| * @param parentingInfo How the custom error should be attached (default = false), | ||
| * [case number]: To which open action the custom error event should be attached, | ||
| * [case boolean]: If true it will get attached to the current active action | ||
| */ | ||
@@ -500,3 +567,3 @@ reportCustomError(key: string, value: string, hint?: string, parentingInfo?: number | boolean): void; | ||
| * Enables manual page detection. | ||
| * After this is called agent will stop detecting pages and will only accept pages from an API call. | ||
| * After this is called the RUM monitoring code will stop detecting page and page group names automatically and only accepts them via {@link setPage}. | ||
| * It is recommended to call this as early as possible. | ||
@@ -507,3 +574,3 @@ */ | ||
| /** | ||
| * Starts a new view and reports it to dynatrace server. | ||
| * Starts a new page view and reports it to dynatrace server. | ||
| * | ||
@@ -514,3 +581,3 @@ * @param newPage New page containing page name and page group. | ||
| * -1 if page that is being set is the same as previous one. | ||
| * -2 if page is trying to be set but mechanism is not active. Probably "dtrum.enableManualPageDetection()" was not called. | ||
| * -2 if page is trying to be set but mechanism is not active. Probably 'dtrum.enableManualPageDetection()' was not called. | ||
| * Negative number means new page failed to start and positive means that new page is started successfully. | ||
@@ -517,0 +584,0 @@ */ |
| { | ||
| "name": "@dynatrace/dtrum-api-types", | ||
| "version": "1.221.12", | ||
| "version": "1.223.5", | ||
| "description": "Typescript types for Dynatrace jsagents dtrum api.", | ||
@@ -5,0 +5,0 @@ "main": "", |
@@ -5,3 +5,3 @@ # Dynatrace Dtrum Api Types | ||
| Keep in mind that when the javascript agent is updated, this type package might not provide accurate types. | ||
| Version: 1.221.12 | ||
| Version: 1.223.5 | ||
@@ -8,0 +8,0 @@ ## Installation |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by21.83%
29097
- Lines of code
- increased by14.32%
543
No dependency changes