@microsoft/applicationinsights-clickanalytics-js 3.0.0-beta.2303-11 → 3.0.0-nightly3.2304-28

package/dist/applicationinsights-clickanalytics-js.api.json

@@ -1,695 +0,0 @@
-{
-  "metadata": {
-    "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.34.4",
-    "schemaVersion": 1011,
-    "oldestForwardsCompatibleVersion": 1001,
-    "tsdocConfig": {
-      "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-      "noStandardTags": true,
-      "tagDefinitions": [
-        {
-          "tagName": "@alpha",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@beta",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@defaultValue",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@decorator",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@deprecated",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@eventProperty",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@example",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@experimental",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@inheritDoc",
-          "syntaxKind": "inline"
-        },
-        {
-          "tagName": "@internal",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@label",
-          "syntaxKind": "inline"
-        },
-        {
-          "tagName": "@link",
-          "syntaxKind": "inline",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@override",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@packageDocumentation",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@param",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@privateRemarks",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@public",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@readonly",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@remarks",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@returns",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@sealed",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@see",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@throws",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@typeParam",
-          "syntaxKind": "block",
-          "allowMultiple": true
-        },
-        {
-          "tagName": "@virtual",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@betaDocumentation",
-          "syntaxKind": "modifier"
-        },
-        {
-          "tagName": "@internalRemarks",
-          "syntaxKind": "block"
-        },
-        {
-          "tagName": "@preapproved",
-          "syntaxKind": "modifier"
-        }
-      ],
-      "supportForTags": {
-        "@alpha": true,
-        "@beta": true,
-        "@defaultValue": true,
-        "@decorator": true,
-        "@deprecated": true,
-        "@eventProperty": true,
-        "@example": true,
-        "@experimental": true,
-        "@inheritDoc": true,
-        "@internal": true,
-        "@label": true,
-        "@link": true,
-        "@override": true,
-        "@packageDocumentation": true,
-        "@param": true,
-        "@privateRemarks": true,
-        "@public": true,
-        "@readonly": true,
-        "@remarks": true,
-        "@returns": true,
-        "@sealed": true,
-        "@see": true,
-        "@throws": true,
-        "@typeParam": true,
-        "@virtual": true,
-        "@betaDocumentation": true,
-        "@internalRemarks": true,
-        "@preapproved": true
-      },
-      "reportUnsupportedHtmlElements": false
-    }
-  },
-  "kind": "Package",
-  "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!",
-  "docComment": "",
-  "name": "@microsoft/applicationinsights-clickanalytics-js",
-  "preserveMemberOrder": false,
-  "members": [
-    {
-      "kind": "EntryPoint",
-      "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!",
-      "name": "",
-      "preserveMemberOrder": false,
-      "members": [
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!BehaviorEnumValidator:function(1)",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function BehaviorEnumValidator(enumObj: "
-            },
-            {
-              "kind": "Content",
-              "text": "any"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "(key: string) => any"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "types/common/Utils.d.ts",
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "enumObj",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "BehaviorEnumValidator"
-        },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!BehaviorMapValidator:function(1)",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function BehaviorMapValidator(map: "
-            },
-            {
-              "kind": "Content",
-              "text": "any"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "(key: string) => any"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "types/common/Utils.d.ts",
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "map",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "BehaviorMapValidator"
-        },
-        {
-          "kind": "Function",
-          "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!BehaviorValueValidator:function(1)",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function BehaviorValueValidator(behaviorArray: "
-            },
-            {
-              "kind": "Content",
-              "text": "string[]"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "(key: string) => string"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "types/common/Utils.d.ts",
-          "returnTypeTokenRange": {
-            "startIndex": 3,
-            "endIndex": 4
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "behaviorArray",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            }
-          ],
-          "name": "BehaviorValueValidator"
-        },
-        {
-          "kind": "Class",
-          "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin:class",
-          "docComment": "",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare class ClickAnalyticsPlugin extends "
-            },
-            {
-              "kind": "Reference",
-              "text": "BaseTelemetryPlugin",
-              "canonicalReference": "@microsoft/applicationinsights-core-js!BaseTelemetryPlugin:class"
-            },
-            {
-              "kind": "Content",
-              "text": " "
-            }
-          ],
-          "fileUrlPath": "types/ClickAnalyticsPlugin.d.ts",
-          "releaseTag": "Public",
-          "isAbstract": false,
-          "name": "ClickAnalyticsPlugin",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "Constructor",
-              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin:constructor(1)",
-              "docComment": "/**\n * Constructs a new instance of the `ClickAnalyticsPlugin` class\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "constructor();"
-                }
-              ],
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": []
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin#identifier:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "identifier: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "identifier",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin#initialize:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "initialize(config: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IConfiguration",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IConfiguration:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": " & "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IConfig",
-                  "canonicalReference": "@microsoft/applicationinsights-common!IConfig:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", core: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IAppInsightsCore",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IAppInsightsCore:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", extensions: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IPlugin",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IPlugin:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "[]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", pluginChain?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ITelemetryPluginChain",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryPluginChain:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 12,
-                "endIndex": 13
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "config",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 4
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "core",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 5,
-                    "endIndex": 6
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "extensions",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 7,
-                    "endIndex": 9
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "pluginChain",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 10,
-                    "endIndex": 11
-                  },
-                  "isOptional": true
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "initialize"
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin#priority:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "priority: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "number"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "priority",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin#processTelemetry:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "processTelemetry(env: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ITelemetryItem",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!ITelemetryItem:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", itemCtx?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IProcessTelemetryContext",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!IProcessTelemetryContext:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "env",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": false
-                },
-                {
-                  "parameterName": "itemCtx",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": true
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "processTelemetry"
-            },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin#trackPageAction:member(1)",
-              "docComment": "/**\n * Logs a page action event.\n *\n * @param IPageActionTelemetry - \n *\n * @param customProperties - Additional data used to filter events and metrics. Defaults to empty.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "trackPageAction(pageAction?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IPageActionTelemetry",
-                  "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!~IPageActionTelemetry:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ", customProperties?: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "ICustomProperties",
-                  "canonicalReference": "@microsoft/applicationinsights-core-js!ICustomProperties:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 6
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "pageAction",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  },
-                  "isOptional": true
-                },
-                {
-                  "parameterName": "customProperties",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 3,
-                    "endIndex": 4
-                  },
-                  "isOptional": true
-                }
-              ],
-              "isOptional": false,
-              "isAbstract": false,
-              "name": "trackPageAction"
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@microsoft/applicationinsights-clickanalytics-js!ClickAnalyticsPlugin.Version:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "static Version: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "Version",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": true,
-              "isProtected": false,
-              "isAbstract": false
-            }
-          ],
-          "extendsTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          },
-          "implementsTokenRanges": []
-        }
-      ]
-    }
-  ]
-}