@types/office-js 1.0.245 → 1.0.246

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.
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 31 Mar 2022 18:31:49 GMT
11
+ * Last updated: Thu, 07 Apr 2022 21:31:17 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
office-js/index.d.ts CHANGED
@@ -411,6 +411,9 @@ declare namespace Office {
411
411
  }
412
412
  /**
413
413
  * Specifies the host Office application in which the add-in is running.
414
+ *
415
+ * @remarks
416
+ * **Important**: In Outlook, this enum is available from Mailbox requirement set 1.5.
414
417
  */
415
418
  enum HostType {
416
419
  /**
@@ -448,6 +451,9 @@ declare namespace Office {
448
451
  }
449
452
  /**
450
453
  * Specifies the OS or other platform on which the Office host application is running.
454
+ *
455
+ * @remarks
456
+ * **Important**: In Outlook, this enum is available from Mailbox requirement set 1.5.
451
457
  */
452
458
  enum PlatformType {
453
459
  /**
@@ -463,7 +469,7 @@ declare namespace Office {
463
469
  */
464
470
  Mac,
465
471
  /**
466
- * The platform an iOS device.
472
+ * The platform is an iOS device.
467
473
  */
468
474
  iOS,
469
475
  /**
@@ -785,6 +791,12 @@ declare namespace Office {
785
791
  contentLanguage: string;
786
792
  /**
787
793
  * Gets information about the environment in which the add-in is running.
794
+ *
795
+ * @remarks
796
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5.
797
+ * For all Mailbox requirement sets, you can use the
798
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
799
+ * property to get similar information.
788
800
  */
789
801
  diagnostics: ContextInformation;
790
802
  /**
@@ -825,8 +837,12 @@ declare namespace Office {
825
837
  /**
826
838
  * Contains the Office application host in which the add-in is running.
827
839
  *
828
- * **Important**: In Outlook, this property is available from requirement set 1.5.
829
- * For all Mailbox requirement sets, you can use the `Office.context.diagnostics` property to get the host.
840
+ * @remarks
841
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
842
+ * `Office.context.diagnostics` property to get the host starting with requirement set 1.5. For all
843
+ * Mailbox requirement sets, you can use the
844
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
845
+ * property to get similar information.
830
846
  */
831
847
  host: HostType;
832
848
  /**
@@ -858,8 +874,12 @@ declare namespace Office {
858
874
  /**
859
875
  * Provides the platform on which the add-in is running.
860
876
  *
861
- * **Important**: In Outlook, this property is available from requirement set 1.5.
862
- * For all Mailbox requirement sets, you can use the `Office.context.diagnostics` property to get the platform.
877
+ * @remarks
878
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
879
+ * `Office.context.diagnostics` property to get the platform starting with requirement set 1.5. For all
880
+ * Mailbox requirement sets, you can use the
881
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
882
+ * property to get similar information.
863
883
  */
864
884
  platform: PlatformType;
865
885
  /**
@@ -1472,6 +1492,12 @@ declare namespace Office {
1472
1492
  }
1473
1493
  /**
1474
1494
  * Provides information about the environment in which the add-in is running.
1495
+ *
1496
+ * @remarks
1497
+ * **Important**: In Outlook, this object is available from Mailbox requirement set 1.5.
1498
+ * For all Mailbox requirement sets, you can use the
1499
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
1500
+ * property to get similar information.
1475
1501
  */
1476
1502
  interface ContextInformation {
1477
1503
  /**
@@ -12455,6 +12481,10 @@ declare namespace Office {
12455
12481
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
12456
12482
  *
12457
12483
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12484
+ *
12485
+ * Starting with Mailbox requirement set 1.5, you can also use the
12486
+ * {@link https://docs.microsoft.com/javascript/api/office/office.context?view=outlook-js-1.5&preserve-view=true#office-office-context-diagnostics-member | Office.context.diagnostics}
12487
+ * property to get similar information.
12458
12488
  */
12459
12489
  interface Diagnostics {
12460
12490
  /**
@@ -13281,13 +13311,17 @@ declare namespace Office {
13281
13311
  * and `ThreeColumns` - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns
13282
13312
  * that can be displayed.
13283
13313
  *
13284
- * More information is under {@link Office.Diagnostics}.
13314
+ * More information is under {@link Office.Diagnostics}.
13285
13315
  *
13286
13316
  * @remarks
13287
13317
  *
13288
13318
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
13289
13319
  *
13290
13320
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
13321
+ *
13322
+ * Starting with Mailbox requirement set 1.5, you can also use the
13323
+ * {@link https://docs.microsoft.com/javascript/api/office/office.context?view=outlook-js-1.5&preserve-view=true#office-office-context-diagnostics-member | Office.context.diagnostics}
13324
+ * property to get similar information.
13291
13325
  */
13292
13326
  diagnostics: Diagnostics;
13293
13327
  /**
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.245",
3
+ "version": "1.0.246",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "3e054f529246bb5176c7c8f6c2d2d89203fa1b946ab9d6d2538b39d8598f9589",
48
+ "typesPublisherContentHash": "ed4f0a259654d5ea6da54c8d7bf96b6c1dcb1f7b3579dbcf671aefb8b4b3f478",
49
49
  "typeScriptVersion": "3.9"
50
50
  }