@openfin/fdc3-api 43.100.109 → 43.100.110

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1418,29 +1418,26 @@ declare type ApplicationWindowInfo = {
1418
1418
  };
1419
1419
 
1420
1420
  /**
1421
- * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled when the app logging feature is enabled for its application.
1421
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1422
1422
  *
1423
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1424
- *
1425
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1426
- *
1427
- * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
1428
- * controlling a url's appLogLevel, its options will be ignored.
1423
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
1424
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1429
1425
  *
1430
1426
  * @default 'debug'
1431
1427
  *
1428
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1429
+ *
1432
1430
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1433
1431
  *
1434
1432
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1435
1433
  *
1436
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1434
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1437
1435
  *
1438
1436
  * ```ts
1439
1437
  * {
1440
1438
  * <rest of settings>
1441
1439
  * "platform": {
1442
1440
  * <rest of settings>
1443
- * "enableAppLogging": "true",
1444
1441
  * "defaultViewOptions": {
1445
1442
  * "appLogLevel": "warn"
1446
1443
  * },
@@ -9859,10 +9856,12 @@ declare type MutableWindowOptions = {
9859
9856
  */
9860
9857
  customData: any;
9861
9858
  /**
9862
- * @deprecated Will be removed in runtime version 45
9863
9859
  *
9864
9860
  * Show the window's frame.
9865
9861
  *
9862
+ * @remarks
9863
+ * This property will not be updatable starting runtime version 45.
9864
+ *
9866
9865
  * @default true
9867
9866
  */
9868
9867
  frame: boolean;
@@ -1418,29 +1418,26 @@ declare type ApplicationWindowInfo = {
1418
1418
  };
1419
1419
 
1420
1420
  /**
1421
- * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled when the app logging feature is enabled for its application.
1421
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1422
1422
  *
1423
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1424
- *
1425
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1426
- *
1427
- * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
1428
- * controlling a url's appLogLevel, its options will be ignored.
1423
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
1424
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1429
1425
  *
1430
1426
  * @default 'debug'
1431
1427
  *
1428
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1429
+ *
1432
1430
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1433
1431
  *
1434
1432
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1435
1433
  *
1436
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1434
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1437
1435
  *
1438
1436
  * ```ts
1439
1437
  * {
1440
1438
  * <rest of settings>
1441
1439
  * "platform": {
1442
1440
  * <rest of settings>
1443
- * "enableAppLogging": "true",
1444
1441
  * "defaultViewOptions": {
1445
1442
  * "appLogLevel": "warn"
1446
1443
  * },
@@ -9859,10 +9856,12 @@ declare type MutableWindowOptions = {
9859
9856
  */
9860
9857
  customData: any;
9861
9858
  /**
9862
- * @deprecated Will be removed in runtime version 45
9863
9859
  *
9864
9860
  * Show the window's frame.
9865
9861
  *
9862
+ * @remarks
9863
+ * This property will not be updatable starting runtime version 45.
9864
+ *
9866
9865
  * @default true
9867
9866
  */
9868
9867
  frame: boolean;
@@ -1418,29 +1418,26 @@ declare type ApplicationWindowInfo = {
1418
1418
  };
1419
1419
 
1420
1420
  /**
1421
- * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled when the app logging feature is enabled for its application.
1421
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1422
1422
  *
1423
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1424
- *
1425
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1426
- *
1427
- * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
1428
- * controlling a url's appLogLevel, its options will be ignored.
1423
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
1424
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1429
1425
  *
1430
1426
  * @default 'debug'
1431
1427
  *
1428
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1429
+ *
1432
1430
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1433
1431
  *
1434
1432
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1435
1433
  *
1436
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1434
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1437
1435
  *
1438
1436
  * ```ts
1439
1437
  * {
1440
1438
  * <rest of settings>
1441
1439
  * "platform": {
1442
1440
  * <rest of settings>
1443
- * "enableAppLogging": "true",
1444
1441
  * "defaultViewOptions": {
1445
1442
  * "appLogLevel": "warn"
1446
1443
  * },
@@ -9859,10 +9856,12 @@ declare type MutableWindowOptions = {
9859
9856
  */
9860
9857
  customData: any;
9861
9858
  /**
9862
- * @deprecated Will be removed in runtime version 45
9863
9859
  *
9864
9860
  * Show the window's frame.
9865
9861
  *
9862
+ * @remarks
9863
+ * This property will not be updatable starting runtime version 45.
9864
+ *
9866
9865
  * @default true
9867
9866
  */
9868
9867
  frame: boolean;
package/out/fdc3-api.d.ts CHANGED
@@ -1424,29 +1424,26 @@ declare type ApplicationWindowInfo = {
1424
1424
  };
1425
1425
 
1426
1426
  /**
1427
- * `appLogLevel` allows the verbosity of app logs that are collected for a Window or View to be controlled when the app logging feature is enabled for its application.
1427
+ * The `appLogLevel` option allows the verbosity of app logs that are collected for a Window or View to be controlled for its application.
1428
1428
  *
1429
- * Please note, `enableAppLogging` must be specified in the application manifest's `platform` or `startup_app` key for this feature to be activated.
1430
- *
1431
- * If not specified, and `enableAppLogging` is true for the application, the default level will be 'silent'.
1432
- *
1433
- * This setting can also be specified in a Domain Setting Rule, allowing per url exceptions to the default behavior to be made. Please note, when a domain setting is actively
1434
- * controlling a url's appLogLevel, its options will be ignored.
1429
+ * This setting can also be specified in a Domain Setting Rule, allowing per url overrides to be defined. Please note, when a domain setting is actively
1430
+ * controlling a url's appLogLevel, its view/window options will be ignored.
1435
1431
  *
1436
1432
  * @default 'debug'
1437
1433
  *
1434
+ * Please note, if the manifest setting `platform.enableAppLogging` or `startup_app.enableAppLogging` is set to `false`, this feature will be disabled.
1435
+ *
1438
1436
  * @example Controlling App Logs With DefaultViewOptions + Domain Settings
1439
1437
  *
1440
1438
  * In this example manifest, we use `defaultViewOptions to set the default verbosity to 'warn'.
1441
1439
  *
1442
- * We also use domain settings to suppress logs entirely for an example URL, and to lower verbosity to 'debug' for another.
1440
+ * We also use domain settings to suppress logs for an example URL, and to lower verbosity to 'debug' for another.
1443
1441
  *
1444
1442
  * ```ts
1445
1443
  * {
1446
1444
  * <rest of settings>
1447
1445
  * "platform": {
1448
1446
  * <rest of settings>
1449
- * "enableAppLogging": "true",
1450
1447
  * "defaultViewOptions": {
1451
1448
  * "appLogLevel": "warn"
1452
1449
  * },
@@ -10172,10 +10169,12 @@ declare type MutableWindowOptions = {
10172
10169
  */
10173
10170
  customData: any;
10174
10171
  /**
10175
- * @deprecated Will be removed in runtime version 45
10176
10172
  *
10177
10173
  * Show the window's frame.
10178
10174
  *
10175
+ * @remarks
10176
+ * This property will not be updatable starting runtime version 45.
10177
+ *
10179
10178
  * @default true
10180
10179
  */
10181
10180
  frame: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "43.100.109",
3
+ "version": "43.100.110",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,