@types/office-js-preview 1.0.293 → 1.0.294

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.
@@ -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-preview.
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:18 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -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
  /**
@@ -883,6 +889,12 @@ declare namespace Office {
883
889
  contentLanguage: string;
884
890
  /**
885
891
  * Gets information about the environment in which the add-in is running.
892
+ *
893
+ * @remarks
894
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5.
895
+ * For all Mailbox requirement sets, you can use the
896
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
897
+ * property to get similar information.
886
898
  */
887
899
  diagnostics: ContextInformation;
888
900
  /**
@@ -923,8 +935,12 @@ declare namespace Office {
923
935
  /**
924
936
  * Contains the Office application host in which the add-in is running.
925
937
  *
926
- * **Important**: In Outlook, this property is available from requirement set 1.5.
927
- * For all Mailbox requirement sets, you can use the `Office.context.diagnostics` property to get the host.
938
+ * @remarks
939
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
940
+ * `Office.context.diagnostics` property to get the host starting with requirement set 1.5. For all
941
+ * Mailbox requirement sets, you can use the
942
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
943
+ * property to get similar information.
928
944
  */
929
945
  host: HostType;
930
946
  /**
@@ -956,8 +972,12 @@ declare namespace Office {
956
972
  /**
957
973
  * Provides the platform on which the add-in is running.
958
974
  *
959
- * **Important**: In Outlook, this property is available from requirement set 1.5.
960
- * For all Mailbox requirement sets, you can use the `Office.context.diagnostics` property to get the platform.
975
+ * @remarks
976
+ * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
977
+ * `Office.context.diagnostics` property to get the platform starting with requirement set 1.5. For all
978
+ * Mailbox requirement sets, you can use the
979
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
980
+ * property to get similar information.
961
981
  */
962
982
  platform: PlatformType;
963
983
  /**
@@ -1582,6 +1602,12 @@ declare namespace Office {
1582
1602
  }
1583
1603
  /**
1584
1604
  * Provides information about the environment in which the add-in is running.
1605
+ *
1606
+ * @remarks
1607
+ * **Important**: In Outlook, this object is available from Mailbox requirement set 1.5.
1608
+ * For all Mailbox requirement sets, you can use the
1609
+ * {@link https://docs.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-preview&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
1610
+ * property to get similar information.
1585
1611
  */
1586
1612
  interface ContextInformation {
1587
1613
  /**
@@ -12847,6 +12873,10 @@ declare namespace Office {
12847
12873
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
12848
12874
  *
12849
12875
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
12876
+ *
12877
+ * Starting with Mailbox requirement set 1.5, you can also use the
12878
+ * {@link https://docs.microsoft.com/javascript/api/office/office.context?view=outlook-js-preview&preserve-view=true#office-office-context-diagnostics-member | Office.context.diagnostics}
12879
+ * property to get similar information.
12850
12880
  */
12851
12881
  interface Diagnostics {
12852
12882
  /**
@@ -13680,6 +13710,10 @@ declare namespace Office {
13680
13710
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
13681
13711
  *
13682
13712
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
13713
+ *
13714
+ * Starting with Mailbox requirement set 1.5, you can also use the
13715
+ * {@link https://docs.microsoft.com/javascript/api/office/office.context?view=outlook-js-preview&preserve-view=true#office-office-context-diagnostics-member | Office.context.diagnostics}
13716
+ * property to get similar information.
13683
13717
  */
13684
13718
  diagnostics: Diagnostics;
13685
13719
  /**
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.293",
3
+ "version": "1.0.294",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "c403a2f7d71a9f00a7bf57130a4cef2be06c4f950c98429dca4e12b8c1f3d35f",
48
+ "typesPublisherContentHash": "e0a1c58c6e6b93a273efb5fcef69a42122c5cddcb49003e7e761c44b18cd0243",
49
49
  "typeScriptVersion": "3.9"
50
50
  }