@types/office-js-preview 1.0.533 → 1.0.535

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-preview (https://github.com
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: Tue, 19 Nov 2024 18:38:08 GMT
11
+ * Last updated: Thu, 21 Nov 2024 00:04:08 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -9406,6 +9406,48 @@ declare namespace Office {
9406
9406
  */
9407
9407
  NoMove = "noMove"
9408
9408
  }
9409
+ /**
9410
+ * Specifies the location from which an add-in wants to access data.
9411
+ *
9412
+ * @remarks
9413
+ *
9414
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
9415
+ *
9416
+ * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
9417
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
9418
+ */
9419
+ enum OpenLocation {
9420
+ /**
9421
+ * A location associated with an account within an add-in.
9422
+ */
9423
+ AccountDocument,
9424
+ /**
9425
+ * The device's camera.
9426
+ */
9427
+ Camera,
9428
+ /**
9429
+ * Local storage on a device.
9430
+ */
9431
+ Local,
9432
+ /**
9433
+ * OneDrive for Business.
9434
+ *
9435
+ * **Important**: For OneDrive Personal, use OTHER.
9436
+ */
9437
+ OnedriveForBusiness,
9438
+ /**
9439
+ * Other cloud storage providers, including OneDrive Personal.
9440
+ */
9441
+ Other,
9442
+ /**
9443
+ * The device's photo library.
9444
+ */
9445
+ PhotoLibrary,
9446
+ /**
9447
+ * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account).
9448
+ */
9449
+ SharePoint
9450
+ }
9409
9451
  /**
9410
9452
  * Represents the current view of Outlook on the web.
9411
9453
  */
@@ -10112,6 +10154,56 @@ declare namespace Office {
10112
10154
  */
10113
10155
  Beta = "beta"
10114
10156
  }
10157
+ /**
10158
+ * Specifies the location in which an add-in wants to save data.
10159
+ *
10160
+ * @remarks
10161
+ *
10162
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
10163
+ *
10164
+ * **Important**: This enum is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
10165
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
10166
+ */
10167
+ enum SaveLocation {
10168
+ /**
10169
+ * A location associated with an account within an add-in.
10170
+ */
10171
+ AccountDocument,
10172
+ /**
10173
+ * Box.
10174
+ */
10175
+ Box,
10176
+ /**
10177
+ * Dropbox.
10178
+ */
10179
+ Dropbox,
10180
+ /**
10181
+ * Google Drive.
10182
+ */
10183
+ GoogleDrive,
10184
+ /**
10185
+ * Local storage on a device.
10186
+ */
10187
+ Local,
10188
+ /**
10189
+ * OneDrive for Business.
10190
+ *
10191
+ * **Important**: For OneDrive Personal, use OTHER.
10192
+ */
10193
+ OnedriveForBusiness,
10194
+ /**
10195
+ * Other cloud storage providers, including OneDrive Personal.
10196
+ */
10197
+ Other,
10198
+ /**
10199
+ * The device's photo library.
10200
+ */
10201
+ PhotoLibrary,
10202
+ /**
10203
+ * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account).
10204
+ */
10205
+ SharePoint
10206
+ }
10115
10207
  /**
10116
10208
  * Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option}
10117
10209
  * that overrides the option set in the manifest at runtime.
@@ -10484,7 +10576,7 @@ declare namespace Office {
10484
10576
  * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
10485
10577
  *
10486
10578
  * @remarks
10487
- * [Api set: Mailbox 1.1]
10579
+ * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
10488
10580
  *
10489
10581
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
10490
10582
  *
@@ -10492,8 +10584,11 @@ declare namespace Office {
10492
10584
  *
10493
10585
  * **Important**:
10494
10586
  *
10587
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
10588
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
10589
+ *
10495
10590
  * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
10496
- * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
10591
+ * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
10497
10592
  * introduced with requirement set 1.8.
10498
10593
  *
10499
10594
  * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that
@@ -10528,7 +10623,7 @@ declare namespace Office {
10528
10623
  * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
10529
10624
  *
10530
10625
  * @remarks
10531
- * [Api set: Mailbox 1.1]
10626
+ * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
10532
10627
  *
10533
10628
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
10534
10629
  *
@@ -10536,8 +10631,11 @@ declare namespace Office {
10536
10631
  *
10537
10632
  * **Important**:
10538
10633
  *
10634
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
10635
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
10636
+ *
10539
10637
  * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
10540
- * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
10638
+ * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
10541
10639
  * introduced with requirement set 1.8.
10542
10640
  *
10543
10641
  * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that
@@ -17731,6 +17829,73 @@ declare namespace Office {
17731
17829
  * @param userContext - Optional. Any state data that is passed to the asynchronous method.
17732
17830
  */
17733
17831
  getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
17832
+ /**
17833
+ * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}.
17834
+ *
17835
+ * @remarks
17836
+ *
17837
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17838
+ *
17839
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
17840
+ *
17841
+ * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
17842
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17843
+ *
17844
+ * **Errors**:
17845
+ *
17846
+ * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy.
17847
+ *
17848
+ * @returns True if the current mailbox is managed by Microsoft Intune.
17849
+ */
17850
+ getIsIdentityManaged(): boolean;
17851
+ /**
17852
+ * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy}
17853
+ * allows an add-in to access data from the specified location.
17854
+ *
17855
+ * @remarks
17856
+ *
17857
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17858
+ *
17859
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
17860
+ *
17861
+ * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
17862
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17863
+ *
17864
+ * **Errors**:
17865
+ *
17866
+ * - `InvalidOpenLocationInput`: The value of the specified location is invalid.
17867
+ *
17868
+ * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy.
17869
+ *
17870
+ * @param openLocation - The location from which the add-in is attempting to access data.
17871
+ *
17872
+ * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location.
17873
+ */
17874
+ getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;
17875
+ /**
17876
+ * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy}
17877
+ * allows an add-in to save data to the specified location.
17878
+ *
17879
+ * @remarks
17880
+ *
17881
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
17882
+ *
17883
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
17884
+ *
17885
+ * **Important**: This method is only supported in Outlook on Android and on iOS starting in Version 4.2443.0. To learn more about APIs supported in Outlook on mobile devices, see
17886
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
17887
+ *
17888
+ * **Errors**:
17889
+ *
17890
+ * - `InvalidSaveLocationInput`: The value of the specified location is invalid.
17891
+ *
17892
+ * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy.
17893
+ *
17894
+ * @param saveLocation - The location in which the add-in is attempting to save data.
17895
+ *
17896
+ * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location.
17897
+ */
17898
+ getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;
17734
17899
  /**
17735
17900
  * Gets currently selected messages on which an add-in can activate and perform operations. An add-in can activate on a maximum of 100 messages at a time.
17736
17901
  * To learn more about item multi-select, see
@@ -18516,7 +18681,7 @@ declare namespace Office {
18516
18681
  * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
18517
18682
  *
18518
18683
  * @remarks
18519
- * [Api set: Mailbox 1.1]
18684
+ * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
18520
18685
  *
18521
18686
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18522
18687
  *
@@ -18524,8 +18689,11 @@ declare namespace Office {
18524
18689
  *
18525
18690
  * **Important**:
18526
18691
  *
18692
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
18693
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
18694
+ *
18527
18695
  * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
18528
- * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
18696
+ * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
18529
18697
  * introduced with requirement set 1.8.
18530
18698
  *
18531
18699
  * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that
@@ -18559,7 +18727,7 @@ declare namespace Office {
18559
18727
  * The `addFileAttachmentAsync` method uploads the file at the specified URI and attaches it to the item in the compose form.
18560
18728
  *
18561
18729
  * @remarks
18562
- * [Api set: Mailbox 1.1]
18730
+ * [Api set: Mailbox 1.1 for Outlook on Windows (classic) and on Mac, Mailbox 1.8 for Outlook on the web and new Outlook on Windows]
18563
18731
  *
18564
18732
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18565
18733
  *
@@ -18567,8 +18735,11 @@ declare namespace Office {
18567
18735
  *
18568
18736
  * **Important**:
18569
18737
  *
18738
+ * - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
18739
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
18740
+ *
18570
18741
  * - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
18571
- * this action (whether using this API or the Outlook UI). To work around this issue, you can try using the `addFileAttachmentFromBase64` API
18742
+ * this action (whether using this API or the Outlook UI). To work around this issue, use the `addFileAttachmentFromBase64` API
18572
18743
  * introduced with requirement set 1.8.
18573
18744
  *
18574
18745
  * - The URI of the file to be attached must support caching in production. The server hosting the image shouldn't return a `Cache-Control` header that
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.533",
3
+ "version": "1.0.535",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "c86073381f29ebf53b0e38dfbba5398b28fdae7195166b336e90359bbe48561f",
49
+ "typesPublisherContentHash": "39b2667fb8880fbcba66c55f4c9811a33cd1325048589b18ae9e5c62830b84e3",
50
50
  "typeScriptVersion": "4.9",
51
51
  "nonNpm": true
52
52
  }