@microsoft/applicationinsights-web-basic 3.0.0-beta.2211-03 → 3.0.0-beta.2212-03

package/dist/applicationinsights-web-basic.api.json

@@ -2664,6 +2664,41 @@
               "isOptional": false,
               "name": "flush"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#getChannels:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getChannels(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IChannelControls",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IChannelControls:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "name": "getChannels"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#getCookieMgr:member(1)",
@@ -2923,41 +2958,6 @@
               "isOptional": false,
               "name": "getTraceCtx"
             },
-            {
-              "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#getTransmissionControls:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "getTransmissionControls(): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IChannelControls",
-                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IChannelControls:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "[][]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isStatic": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
-              },
-              "releaseTag": "Public",
-              "isProtected": false,
-              "overloadIndex": 1,
-              "parameters": [],
-              "isOptional": false,
-              "name": "getTransmissionControls"
-            },
             {
               "kind": "Property",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!AppInsightsCore#getWParam:member",
@@ -4261,12 +4261,12 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-web-basic!ApplicationInsights#getSKUDefaults:member(1)",
-              "docComment": "",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!ApplicationInsights#initialize:member(1)",
+              "docComment": "/**\n * Initialize this instance of ApplicationInsights\n *\n * @memberof ApplicationInsights\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "getSKUDefaults(): "
+                  "text": "initialize(): "
                 },
                 {
                   "kind": "Content",
@@ -4287,20 +4287,43 @@
               "overloadIndex": 1,
               "parameters": [],
               "isOptional": false,
-              "name": "getSKUDefaults"
+              "name": "initialize"
             },
             {
               "kind": "Method",
-              "canonicalReference": "@microsoft/applicationinsights-web-basic!ApplicationInsights#initialize:member(1)",
-              "docComment": "/**\n * Initialize this instance of ApplicationInsights\n *\n * @memberof ApplicationInsights\n */\n",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!ApplicationInsights#onCfgChange:member(1)",
+              "docComment": "/**\n * Watches and tracks changes for accesses to the current config, and if the accessed config changes the handler will be recalled.\n *\n * @param handler - \n *\n * @returns A watcher handler instance that can be used to remove itself when being unloaded\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "initialize(): "
+                  "text": "onCfgChange(handler: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "WatcherFunction",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!WatcherFunction:type"
                 },
                 {
                   "kind": "Content",
-                  "text": "void"
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IConfiguration",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IConfiguration:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IUnloadHook",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IUnloadHook:interface"
                 },
                 {
                   "kind": "Content",
@@ -4309,15 +4332,24 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
+                "startIndex": 6,
+                "endIndex": 7
               },
               "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
-              "parameters": [],
+              "parameters": [
+                {
+                  "parameterName": "handler",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 5
+                  },
+                  "isOptional": false
+                }
+              ],
               "isOptional": false,
-              "name": "initialize"
+              "name": "onCfgChange"
             },
             {
               "kind": "Method",
@@ -5165,6 +5197,39 @@
               ],
               "name": "flush"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getChannels:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getChannels(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IChannelControls",
+                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IChannelControls:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "getChannels"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getCookieMgr:member(1)",
@@ -5383,39 +5448,6 @@
               ],
               "name": "getTraceCtx"
             },
-            {
-              "kind": "MethodSignature",
-              "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getTransmissionControls:member(1)",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "getTransmissionControls(): "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "IChannelControls",
-                  "canonicalReference": "@microsoft/applicationinsights-web-basic!IChannelControls:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "[][]"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [],
-              "name": "getTransmissionControls"
-            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@microsoft/applicationinsights-web-basic!IAppInsightsCore#getWParam:member",
@@ -10654,7 +10686,7 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type SeverityLevel = "
+              "text": "export type SeverityLevel = "
             },
             {
               "kind": "Content",

package/dist/applicationinsights-web-basic.api.md

@@ -32,6 +32,10 @@ export class AppInsightsCore implements IAppInsightsCore {
     eventCnt(): number;
     evtNamespace(): string;
     flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): void;
+    // Warning: (ae-forgotten-export) The symbol "IChannelControls" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    getChannels(): IChannelControls[];
     // Warning: (ae-forgotten-export) The symbol "ICookieMgr" needs to be exported by the entry point index.d.ts
     getCookieMgr(): ICookieMgr;
     // (undocumented)
@@ -48,10 +52,6 @@ export class AppInsightsCore implements IAppInsightsCore {
     getProcessTelContext(): IProcessTelemetryContext;
     // Warning: (ae-forgotten-export) The symbol "IDistributedTraceContext" needs to be exported by the entry point index.d.ts
     getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
-    // Warning: (ae-forgotten-export) The symbol "IChannelControls" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    getTransmissionControls(): IChannelControls[][];
     getWParam: () => number;
     // Warning: (ae-forgotten-export) The symbol "INotificationManager" needs to be exported by the entry point index.d.ts
     //
@@ -97,9 +97,8 @@ export class ApplicationInsights {
     evtNamespace(): string;
     flush(async?: boolean): void;
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
-    // (undocumented)
-    getSKUDefaults(): void;
     initialize(): void;
+    onCfgChange(handler: WatcherFunction<IConfiguration>): IUnloadHook;
     // (undocumented)
     pollInternalLogs(): void;
     // (undocumented)
@@ -311,13 +310,13 @@ export interface IAppInsightsCore extends IPerfManagerProvider {
     config: IConfiguration;
     evtNamespace(): string;
     flush(isAsync?: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason, cbTimeout?: number): boolean | void;
+    // (undocumented)
+    getChannels(): IChannelControls[];
     getCookieMgr(): ICookieMgr;
     getNotifyMgr(): INotificationManager;
     getPlugin<T extends IPlugin = IPlugin>(pluginIdentifier: string): ILoadedPlugin<T>;
     getProcessTelContext(): IProcessTelemetryContext;
     getTraceCtx(createNew?: boolean): IDistributedTraceContext | null;
-    // (undocumented)
-    getTransmissionControls(): IChannelControls[][];
     getWParam: () => number;
     // (undocumented)
     initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;

package/dist/applicationinsights-web-basic.d.ts

@@ -1,5 +1,5 @@
 /*
- * Microsoft.ApplicationInsights, 3.0.0-beta.2211-03
+ * Microsoft.ApplicationInsights, 3.0.0-beta.2212-03
  * Copyright (c) Microsoft and contributors. All rights reserved.
  *
  * Microsoft Application Insights Team
@@ -35,7 +35,7 @@ declare namespace ApplicationInsights {
         getWParam: () => number;
         constructor();
         initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
-        getTransmissionControls(): IChannelControls[][];
+        getChannels(): IChannelControls[];
         track(telemetryItem: ITelemetryItem): void;
         getProcessTelContext(): IProcessTelemetryContext;
         getNotifyMgr(): INotificationManager;
@@ -186,7 +186,6 @@ declare namespace ApplicationInsights {
         flush(async?: boolean): void;
         pollInternalLogs(): void;
         stopPollingInternalLogs(): void;
-        getSKUDefaults(): void;
         /**
          * Unload and Tear down the SDK and any initialized plugins, after calling this the SDK will be considered
          * to be un-initialized and non-operational, re-initializing the SDK should only be attempted if the previous
@@ -217,6 +216,13 @@ declare namespace ApplicationInsights {
          * @param handler - the handler
          */
         addUnloadCb(handler: UnloadHandler): void;
+        /**
+         * Watches and tracks changes for accesses to the current config, and if the accessed config changes the
+         * handler will be recalled.
+         * @param handler
+         * @returns A watcher handler instance that can be used to remove itself when being unloaded
+         */
+        onCfgChange(handler: WatcherFunction<IConfiguration>): IUnloadHook;
     }
 
     export { arrForEach }
@@ -465,7 +471,7 @@ declare namespace ApplicationInsights {
          */
         isInitialized?: () => boolean;
         initialize(config: IConfiguration, extensions: IPlugin[], logger?: IDiagnosticLogger, notificationManager?: INotificationManager): void;
-        getTransmissionControls(): IChannelControls[][];
+        getChannels(): IChannelControls[];
         track(telemetryItem: ITelemetryItem): void;
         /**
          * Get the current notification manager
@@ -732,11 +738,11 @@ declare namespace ApplicationInsights {
         /**
          * Pause sending data
          */
-        pause(): void;
+        pause?(): void;
         /**
          * Resume sending data
          */
-        resume(): void;
+        resume?(): void;
         /**
          * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
          * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
@@ -745,7 +751,7 @@ declare namespace ApplicationInsights {
          * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
          * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
          */
-        teardown: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
+        teardown?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
         /**
          * Flush to send data immediately; channel should default to sending data asynchronously
          * @param async - send data asynchronously when true
@@ -754,7 +760,7 @@ declare namespace ApplicationInsights {
          * @param sendReason - specify the reason that you are calling "flush" defaults to ManualFlush (1) if not specified
          * @returns - true if the callback will be return after the flush is complete otherwise the caller should assume that any provided callback will never be called
          */
-        flush(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
+        flush?(async: boolean, callBack?: (flushComplete?: boolean) => void, sendReason?: SendRequestReason): boolean | void;
     }
 
     interface IChannelControlsAI extends IChannelControls {