@dynatrace/dtrum-api-types
Advanced tools
@dynatrace/dtrum-api-types - npm Package Compare versions
Comparing version 1.261.2 to 1.263.3
146
dtrum.d.ts
| /** | ||
| * Signature of the function passed as callback in {@link addLeaveActionListener} | ||
| * | ||
| * @param actionId the ID for which the leave is called | ||
| * @param stoptime start resp. endtime of the action | ||
| * @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 | ||
@@ -15,6 +15,6 @@ */ | ||
| * | ||
| * @param actionId the ID for which the enter is called | ||
| * @param starttime start resp. endtime of the action | ||
| * @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 [element] the element which resulted in the initiation of the event | ||
| * @param [element] the element which resulted in the initiation of the event | ||
| */ | ||
@@ -175,4 +175,4 @@ export interface ActionEnterListener { | ||
| * @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 | ||
| * @param message An additional informational message | ||
| * @returns false if the values were incorrect or the function has been called too late, true otherwise | ||
| */ | ||
@@ -186,7 +186,7 @@ markAsErrorPage(responseCode: number, message: string): boolean; | ||
| * | ||
| * @param responseCode The response code of the current XHR action | ||
| * @param message An additional informational message | ||
| * @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 | ||
| * the currently open action is used. | ||
| * @returns false if the values were incorrect or the function has been called too late, true otherwise | ||
| */ | ||
@@ -199,4 +199,4 @@ markXHRFailed(responseCode: number, message: string, parentActionId?: number): boolean; | ||
| * @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 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. | ||
@@ -212,5 +212,5 @@ */ | ||
| * @param actionType DEPRECATED: not used any more and has no effect if provided | ||
| * @param startTime Timestamp in milliseconds. if null, current time is used. | ||
| * @param sourceUrl Source url for the action | ||
| * @returns ID of the created action | ||
| * @param startTime Timestamp in milliseconds. if null, current time is used. | ||
| * @param sourceUrl Source url for the action | ||
| * @returns ID of the created action | ||
| */ | ||
@@ -243,8 +243,8 @@ "enterAction"(actionName: string, actionType?: string, startTime?: number, sourceUrl?: string): number; | ||
| * @see {@link enterAction} | ||
| * @param actionId ID of the action to leave. must be the value returned by enterAction | ||
| * @param stopTime Timestamp in milliseconds. | ||
| * Note that, when providing a stop time, it will force stop the action and prevent visually complete from extending it. | ||
| * @param actionId ID of the action to leave. must be the value returned by enterAction | ||
| * @param stopTime Timestamp in milliseconds. | ||
| * Note that, when providing a stop time, it will force stop the action and prevent visually complete from extending it. | ||
| * @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 | ||
| * RUM monitoring code will ignore it. | ||
| * Note that, when providing a start time, it mustn't be longer than an hour in the past, otherwise the | ||
| * RUM monitoring code will ignore it. | ||
| */ | ||
@@ -260,3 +260,3 @@ "leaveAction"(actionId: number, stopTime?: number, startTime?: number): void; | ||
| * @see {@link addActionProperties} | ||
| * @param listener A function that will be called when leaving an action | ||
| * @param listener A function that will be called when leaving an action | ||
| */ | ||
@@ -267,3 +267,3 @@ addLeaveActionListener(listener: ActionLeaveListener): void; | ||
| * | ||
| * @param listener A leave action listener to be removed | ||
| * @param listener A leave action listener to be removed | ||
| */ | ||
@@ -275,3 +275,3 @@ removeLeaveActionListener(listener: ActionLeaveListener): void; | ||
| * Only accepts valid java long, java double (as a string representation), Date objects, and | ||
| * short strings with a maximum length of 100 characters. <br /> | ||
| * 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. | ||
@@ -281,12 +281,12 @@ * | ||
| * @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 shortString JSON object containing key value pairs of strings.<br /> Value character count should be less | ||
| * than 100 characters | ||
| * @param javaDouble JSON object containing key value pairs of valid floating point numbers.<br /> | ||
| * Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308 | ||
| * @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 shortString JSON object containing key value pairs of strings.<br /> Value character count should be less | ||
| * than 100 characters | ||
| * @param javaDouble JSON object containing key value pairs of valid floating point numbers.<br /> | ||
| * Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308 | ||
| * | ||
| * 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 | ||
| * 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 | ||
| */ | ||
@@ -301,6 +301,6 @@ addActionProperties(parentActionId: number, javaLong?: PropertyMap<number>, date?: PropertyMap<Date>, shortString?: PropertyMap<string>, javaDouble?: PropertyMap<number>): void; | ||
| * | ||
| * @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 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 | ||
@@ -326,11 +326,11 @@ */ | ||
| * 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. | ||
| * set to have triggered the user action. | ||
| * Use when a user input is not automatically detected by the RUM monitoring code. | ||
| * | ||
| * @see {@link endUserInput} | ||
| * @param domNode DOM node which triggered the action (button, etc) or a string 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 domNode DOM node which triggered the action (button, etc) or a string 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 | ||
| * @returns An object containing all the information about the userInput | ||
| */ | ||
@@ -353,9 +353,11 @@ beginUserInput(domNode: HTMLElement | string, type: string, addInfo?: string, validTime?: number): DtRumUserInput; | ||
| * @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 | ||
| * 3 ... Start action if user input is present | ||
| * @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 | ||
| * 3 ... Start action if user input is present | ||
| * @param xhrUrl url of the requested resource | ||
| * @returns ID of the XhrAction | ||
| * note that in the future, this argument will be required | ||
| * if not provided, the request will be marked as `/undefined` in the waterfall | ||
| * @returns ID of the XhrAction | ||
| */ | ||
@@ -366,3 +368,3 @@ enterXhrAction(type: string, xmode?: 0 | 1 | 3, xhrUrl?: string): number; | ||
| * | ||
| * @param actionId ID of the XHR Action | ||
| * @param actionId ID of the XHR Action | ||
| * @param [stopTime] The stop time of the XHR Action | ||
@@ -415,4 +417,4 @@ */ | ||
| * @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 | ||
| * @param actionId The action ID of the to be updated action name | ||
| * @returns an {@link ActionNameResult} whether the process was successful | ||
| */ | ||
@@ -489,3 +491,3 @@ actionName(actionName: string, actionId?: number): ActionNameResult; | ||
| * @param remember If true, this configuration state is persisted in local storage, so that it doesn't | ||
| * reset on each page load | ||
| * reset on each page load | ||
| */ | ||
@@ -497,4 +499,4 @@ disablePersistentValues(remember: boolean): void; | ||
| * @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}. | ||
| * 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}. | ||
| */ | ||
@@ -512,14 +514,14 @@ registerPreDiffMethod(method: (diff: string) => string): void; | ||
| * @param javaLongOrObject 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 shortString JSON object containing key value pairs of strings.<br /> Value character count should be less than | ||
| * 100 characters | ||
| * @param javaDouble JSON object containing key value pairs of valid floating point numbers.<br /> | ||
| * Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308 | ||
| * @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 than | ||
| * 100 characters | ||
| * @param javaDouble JSON object containing key value pairs of valid floating point numbers.<br /> | ||
| * Value should be between range -1.7976931348623157e+308 & 1.7976931348623157e+308 | ||
| * | ||
| * 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 | ||
| * 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 | ||
| * | ||
| * @returns Status report about properties that were passed to the function. | ||
| * It contains data about failed properties with the failure reason. | ||
| * Contains data about properties that were sent successfully and a general message with information about total failed properties. | ||
| * @returns Status report about properties that were passed to the function. | ||
| * It contains data about failed properties with the failure reason. | ||
| * Contains data about properties that were sent successfully and a general message with information about total failed properties. | ||
| */ | ||
@@ -531,3 +533,3 @@ sendSessionProperties( | ||
| javaDouble?: PropertyMap<number> | ||
| // eslint-disable-next-line @dynatrace/dem-eslint-rules/correct-null-void-undefined -- jquery types return void by design - keep native types | ||
| ): PropertiesSendingReport | undefined; | ||
@@ -539,8 +541,8 @@ /** | ||
| * | ||
| * @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 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 | ||
| * [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 | ||
| */ | ||
@@ -562,4 +564,4 @@ reportCustomError(key: string, value: string, hint?: string, parentingInfo?: number | boolean): void; | ||
| * 2 if new page is started during onload. It means it is cached and will be sent with load action. | ||
| * -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. | ||
| * - 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. | ||
| * Negative number means new page failed to start and positive means that new page is started successfully. | ||
@@ -566,0 +568,0 @@ */ |
| { | ||
| "name": "@dynatrace/dtrum-api-types", | ||
| "version": "1.261.2", | ||
| "version": "1.263.3", | ||
| "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.261.2 | ||
| Version: 1.263.3 | ||
@@ -8,0 +8,0 @@ ## Installation |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.27%
28684
- Lines of code
- increased by0.19%
534
No dependency changes