@microsoft/applicationinsights-react-native 2.5.6 → 3.0.1-nightly.2208-03

package/types/ReactNativePlugin.d.ts

@@ -1,16 +1,6 @@
-/**
-* ReactNativePlugin.ts
-* @copyright Microsoft 2019
-*/
 import { BaseTelemetryPlugin, IAppInsightsCore, IPlugin, IProcessTelemetryContext, ITelemetryItem, ITelemetryPlugin } from "@microsoft/applicationinsights-core-js";
 import { IReactNativePluginConfig } from "./Interfaces";
-/**
- * This is a helper function for the equivalent of arForEach(objKeys(target), callbackFn), this is a
- * performance optimization to avoid the creation of a new array for large objects
- * @param target The target object to find and process the keys
- * @param callbackfn The function to call with the details
- */
-export declare function objForEachKey(target: any, callbackfn: (name: string, value: any) => void): void;
+import { IDeviceInfoModule } from "./Interfaces/IDeviceInfoModule";
 export declare class ReactNativePlugin extends BaseTelemetryPlugin {
     identifier: string;
     priority: number;
@@ -21,7 +11,33 @@ export declare class ReactNativePlugin extends BaseTelemetryPlugin {
     initialize(config?: IReactNativePluginConfig | object, // need `| object` to coerce to interface
     core?: IAppInsightsCore, extensions?: IPlugin[]): void;
     processTelemetry(env: ITelemetryItem, itemCtx?: IProcessTelemetryContext): void;
+    /**
+     * Set the module that will be used during initialization when collecting device is enabled
+     * (the default), automatic collection can be disabled via the `disableDeviceCollection`
+     * config. The `react-native-device-info` module will be used by default if no
+     * `deviceInfoModule` is set and collection is enabled.
+     * @param deviceInfoModule
+     */
+    setDeviceInfoModule(deviceInfoModule: IDeviceInfoModule): void;
+    /**
+     * Manually set the deviceId, if set before initialization and automatic device info collection
+     * is enabled this value may get overwritten. If you want to keep this value disable auto
+     * collection by setting the `disableDeviceCollection` config to true.
+     * @param newId - The value to use as the device Id.
+     */
     setDeviceId(newId: string): void;
+    /**
+     * Manually set the device model, if set before initialization and automatic device info
+     * collection is enabled this value may get overwritten. If you want to keep this value
+     * disable auto collection by setting the `disableDeviceCollection` config to true.
+     * @param newModel - The value to use as the device model.
+     */
     setDeviceModel(newModel: string): void;
+    /**
+     * Manually set the device type (class), if set before initialization and automatic device
+     * info collection is enabled this value may get overwritten. If you want to keep this value
+     * disable auto collection by setting the `disableDeviceCollection` config to true.
+     * @param newType - The value to use as the device type
+     */
     setDeviceType(newType: string): void;
 }

package/types/index.d.ts

@@ -1,3 +1,6 @@
 import { ReactNativePlugin } from "./ReactNativePlugin";
 import { INativeDevice, IReactNativePluginConfig } from "./Interfaces";
-export { ReactNativePlugin, INativeDevice, IReactNativePluginConfig };
+import { IDeviceInfoModule } from "./Interfaces/IDeviceInfoModule";
+import { getReactNativeDeviceInfo } from "./DeviceInfo/ReactNativeDeviceInfo";
+export { ReactNativePlugin, INativeDevice, IReactNativePluginConfig, IDeviceInfoModule };
+export { getReactNativeDeviceInfo };

package/types/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.28.6"
+      "packageVersion": "7.29.2"
     }
   ]
 }