@types/office-js 1.0.448 → 1.0.450

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: Tue, 19 Nov 2024 21:02:30 GMT
11
+ * Last updated: Tue, 03 Dec 2024 09:35:08 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -3515,8 +3515,6 @@ declare namespace Office {
3515
3515
  *
3516
3516
  * **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
3517
3517
  *
3518
- * **Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
3519
- *
3520
3518
  * @deprecated Use `Office.auth.getAccessToken` instead.
3521
3519
  *
3522
3520
  * @remarks
@@ -3540,8 +3538,6 @@ declare namespace Office {
3540
3538
  *
3541
3539
  * **Important**: In Outlook, this API isn't supported if the add-in is loaded in an Outlook.com or Gmail mailbox.
3542
3540
  *
3543
- * **Warning**: `getAccessTokenAsync` has been deprecated. Use `Office.auth.getAccessToken` instead.
3544
- *
3545
3541
  * @deprecated Use `Office.auth.getAccessToken` instead.
3546
3542
  *
3547
3543
  * @remarks
@@ -3612,8 +3608,6 @@ declare namespace Office {
3612
3608
  /**
3613
3609
  * Prompts the user to add their Office account (or to switch to it, if it is already added). Default value is `false`.
3614
3610
  *
3615
- * **Warning**: `forceAddAccount` has been deprecated. Use `allowSignInPrompt` instead.
3616
- *
3617
3611
  * @deprecated Use `allowSignInPrompt` instead.
3618
3612
  */
3619
3613
  forceAddAccount?: boolean;
@@ -3621,8 +3615,6 @@ declare namespace Office {
3621
3615
  * Causes Office to display the add-in consent experience. Useful if the add-in's Azure permissions have changed or if the user's consent has
3622
3616
  * been revoked. Default value is `false`.
3623
3617
  *
3624
- * **Warning**: `forceConsent` has been deprecated. Use `allowConsentPrompt` instead.
3625
- *
3626
3618
  * @deprecated Use `allowConsentPrompt` instead.
3627
3619
  */
3628
3620
  forceConsent?: boolean;
@@ -7161,8 +7153,6 @@ declare namespace Office {
7161
7153
  /**
7162
7154
  * Check if the specified requirement set is supported by the Office application.
7163
7155
  *
7164
- * **Warning**: This overload of `isSetSupported` (where `minVersionNumber` is a number) has been deprecated. Use the string overload of `isSetSupported` instead.
7165
- *
7166
7156
  * @deprecated Use the string overload of `isSetSupported` instead.
7167
7157
  * @param name - The requirement set name (e.g., "ExcelApi").
7168
7158
  * @param minVersionNumber - The minimum required version (e.g., 1.4).
@@ -9335,9 +9325,9 @@ declare namespace Office {
9335
9325
  * method. If you're on an Outlook on Windows version that only supports the `postProcessingAction` property,
9336
9326
  * you must assign it different string values. For a list of supported string values, see
9337
9327
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member |
9338
- * Office.SpamReportingEventCompletedOptions.postProcessingAction}.
9339
- */
9340
- enum MoveSpamItemTo {
9328
+ * Office.SpamReportingEventCompletedOptions.postProcessingAction}.
9329
+ */
9330
+ enum MoveSpamItemTo {
9341
9331
  /**
9342
9332
  * Specifies that a reported message is moved to a custom folder in the mailbox.
9343
9333
  */
@@ -9354,7 +9344,49 @@ declare namespace Office {
9354
9344
  * Specifies that a reported message remains in its current folder in the mailbox.
9355
9345
  */
9356
9346
  NoMove = "noMove"
9357
- }
9347
+ }
9348
+ /**
9349
+ * Specifies the location from which an add-in wants to access data.
9350
+ *
9351
+ * @remarks
9352
+ *
9353
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
9354
+ *
9355
+ * **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
9356
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
9357
+ */
9358
+ enum OpenLocation {
9359
+ /**
9360
+ * A location associated with an account within an add-in.
9361
+ */
9362
+ AccountDocument,
9363
+ /**
9364
+ * The device's camera.
9365
+ */
9366
+ Camera,
9367
+ /**
9368
+ * Local storage on a device.
9369
+ */
9370
+ Local,
9371
+ /**
9372
+ * OneDrive for Business.
9373
+ *
9374
+ * **Important**: For OneDrive Personal, use OTHER.
9375
+ */
9376
+ OnedriveForBusiness,
9377
+ /**
9378
+ * Other cloud storage providers, including OneDrive Personal.
9379
+ */
9380
+ Other,
9381
+ /**
9382
+ * The device's photo library.
9383
+ */
9384
+ PhotoLibrary,
9385
+ /**
9386
+ * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account).
9387
+ */
9388
+ SharePoint
9389
+ }
9358
9390
  /**
9359
9391
  * Represents the current view of Outlook on the web.
9360
9392
  */
@@ -10061,6 +10093,56 @@ declare namespace Office {
10061
10093
  */
10062
10094
  Beta = "beta"
10063
10095
  }
10096
+ /**
10097
+ * Specifies the location in which an add-in wants to save data.
10098
+ *
10099
+ * @remarks
10100
+ *
10101
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
10102
+ *
10103
+ * **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
10104
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
10105
+ */
10106
+ enum SaveLocation {
10107
+ /**
10108
+ * A location associated with an account within an add-in.
10109
+ */
10110
+ AccountDocument,
10111
+ /**
10112
+ * Box.
10113
+ */
10114
+ Box,
10115
+ /**
10116
+ * Dropbox.
10117
+ */
10118
+ Dropbox,
10119
+ /**
10120
+ * Google Drive.
10121
+ */
10122
+ GoogleDrive,
10123
+ /**
10124
+ * Local storage on a device.
10125
+ */
10126
+ Local,
10127
+ /**
10128
+ * OneDrive for Business.
10129
+ *
10130
+ * **Important**: For OneDrive Personal, use OTHER.
10131
+ */
10132
+ OnedriveForBusiness,
10133
+ /**
10134
+ * Other cloud storage providers, including OneDrive Personal.
10135
+ */
10136
+ Other,
10137
+ /**
10138
+ * The device's photo library.
10139
+ */
10140
+ PhotoLibrary,
10141
+ /**
10142
+ * SharePoint. Includes both SharePoint Online and SharePoint on-premises (if accessed with a Microsoft Entra ID account).
10143
+ */
10144
+ SharePoint
10145
+ }
10064
10146
  /**
10065
10147
  * Specifies the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events#available-send-mode-options | send mode option}
10066
10148
  * that overrides the option set in the manifest at runtime.
@@ -15597,6 +15679,73 @@ declare namespace Office {
15597
15679
  * @param userContext - Optional. Any state data that is passed to the asynchronous method.
15598
15680
  */
15599
15681
  getCallbackTokenAsync(callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any): void;
15682
+ /**
15683
+ * Returns true if the current mailbox is managed by {@link https://learn.microsoft.com/mem/intune/fundamentals/what-is-intune | Microsoft Intune}.
15684
+ *
15685
+ * @remarks
15686
+ *
15687
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
15688
+ *
15689
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
15690
+ *
15691
+ * **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
15692
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15693
+ *
15694
+ * **Errors**:
15695
+ *
15696
+ * - `MAMServiceNotAvailable`: The client is unable to fetch the mobile application management (MAM) policy.
15697
+ *
15698
+ * @returns True if the current mailbox is managed by Microsoft Intune.
15699
+ */
15700
+ getIsIdentityManaged(): boolean;
15701
+ /**
15702
+ * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy}
15703
+ * allows an add-in to access data from the specified location.
15704
+ *
15705
+ * @remarks
15706
+ *
15707
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
15708
+ *
15709
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
15710
+ *
15711
+ * **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
15712
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15713
+ *
15714
+ * **Errors**:
15715
+ *
15716
+ * - `InvalidOpenLocationInput`: The value of the specified location is invalid.
15717
+ *
15718
+ * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy.
15719
+ *
15720
+ * @param openLocation - The location from which the add-in is attempting to access data.
15721
+ *
15722
+ * @returns True if an organization's Intune MAM policy allows an add-in to access data from the specified location.
15723
+ */
15724
+ getIsOpenFromLocationAllowed(openLocation: MailboxEnums.OpenLocation): boolean;
15725
+ /**
15726
+ * Returns true if an organization's {@link https://learn.microsoft.com/mem/intune/apps/app-management | Intune mobile application management (MAM) policy}
15727
+ * allows an add-in to save data to the specified location.
15728
+ *
15729
+ * @remarks
15730
+ *
15731
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
15732
+ *
15733
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose, Read
15734
+ *
15735
+ * **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
15736
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
15737
+ *
15738
+ * **Errors**:
15739
+ *
15740
+ * - `InvalidSaveLocationInput`: The value of the specified location is invalid.
15741
+ *
15742
+ * - `MAMServiceNotAvailable`: The client is unable to fetch the MAM policy.
15743
+ *
15744
+ * @param saveLocation - The location in which the add-in is attempting to save data.
15745
+ *
15746
+ * @returns True if an organization's Intune MAM policy allows an add-in to save data to the specified location.
15747
+ */
15748
+ getIsSaveToLocationAllowed(saveLocation: MailboxEnums.SaveLocation): boolean;
15600
15749
  /**
15601
15750
  * 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.
15602
15751
  * To learn more about item multi-select, see
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.448",
3
+ "version": "1.0.450",
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",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "f5f3dd019545f4602c3c34a1e72602e3ee054c899f86d498709074bb14c1588e",
50
- "typeScriptVersion": "4.9"
49
+ "typesPublisherContentHash": "fc948d86f1849a9edfc8565c7d32360a7ef1828586216a244b6b35c8d855cf15",
50
+ "typeScriptVersion": "5.0"
51
51
  }