@types/office-js-preview 1.0.536 → 1.0.538
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +60 -52
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -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:
|
|
11
|
+
* Last updated: Thu, 12 Dec 2024 21:33:57 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -17164,12 +17164,11 @@ declare namespace Office {
|
|
|
17164
17164
|
*
|
|
17165
17165
|
* **Important**:
|
|
17166
17166
|
*
|
|
17167
|
-
* - In
|
|
17167
|
+
* - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
|
|
17168
17168
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
|
|
17169
17169
|
* This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
|
|
17170
17170
|
* which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
|
|
17171
|
-
* Nested app authentication is the recommended approach for tokens going forward. For more information, see
|
|
17172
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
|
|
17171
|
+
* Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
17173
17172
|
*
|
|
17174
17173
|
* - This method isn't supported in Outlook on Android or on iOS. For more information on supported APIs in Outlook mobile, see
|
|
17175
17174
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
@@ -17681,12 +17680,11 @@ declare namespace Office {
|
|
|
17681
17680
|
*
|
|
17682
17681
|
* **Important**:
|
|
17683
17682
|
*
|
|
17684
|
-
* - In
|
|
17683
|
+
* - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
|
|
17685
17684
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
|
|
17686
17685
|
* This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
|
|
17687
17686
|
* which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
|
|
17688
|
-
* Nested app authentication is the recommended approach for tokens going forward. For more information, see
|
|
17689
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
|
|
17687
|
+
* Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
17690
17688
|
*
|
|
17691
17689
|
* - The Outlook REST v2.0 and beta endpoints are now deprecated. However, privately released and AppSource-hosted add-ins are able to use the REST service
|
|
17692
17690
|
* until extended support ends for Outlook 2019 on October 14, 2025. Traffic from these add-ins is automatically identified for exemption. This exemption also
|
|
@@ -17746,11 +17744,20 @@ declare namespace Office {
|
|
|
17746
17744
|
*
|
|
17747
17745
|
* **Errors**:
|
|
17748
17746
|
*
|
|
17749
|
-
*
|
|
17747
|
+
* If your call fails, use the {@link https://learn.microsoft.com/javascript/api/office/office.asyncresult#office-office-asyncresult-diagnostics-member | asyncResult.diagnostics}
|
|
17748
|
+
* property to view details about the error.
|
|
17750
17749
|
*
|
|
17751
|
-
* - `
|
|
17750
|
+
* - `GenericTokenError: An internal error has occurred.` - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens
|
|
17751
|
+
* for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the
|
|
17752
|
+
* {@link https://aka.ms/naafaq | FAQ page}.
|
|
17752
17753
|
*
|
|
17753
|
-
* - `
|
|
17754
|
+
* - `HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.`
|
|
17755
|
+
*
|
|
17756
|
+
* - `InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information.` - In Exchange Online environments,
|
|
17757
|
+
* this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in.
|
|
17758
|
+
* For guidance on how to implement NAA, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
17759
|
+
*
|
|
17760
|
+
* - `NetworkError: The user is no longer connected to the network. Please check your network connection and try again.`
|
|
17754
17761
|
*
|
|
17755
17762
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
17756
17763
|
* `isRest`: Determines if the token provided will be used for the Outlook REST APIs or Exchange Web Services. Default value is `false`.
|
|
@@ -17777,12 +17784,11 @@ declare namespace Office {
|
|
|
17777
17784
|
*
|
|
17778
17785
|
* **Important**:
|
|
17779
17786
|
*
|
|
17780
|
-
* - In
|
|
17787
|
+
* - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
|
|
17781
17788
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
|
|
17782
17789
|
* This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
|
|
17783
17790
|
* which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
|
|
17784
|
-
* Nested app authentication is the recommended approach for tokens going forward. For more information, see
|
|
17785
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
|
|
17791
|
+
* Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
17786
17792
|
*
|
|
17787
17793
|
* - You can pass both the token and either an attachment identifier or item identifier to an external system. That system uses
|
|
17788
17794
|
* the token as a bearer authorization token to call the Exchange Web Services (EWS)
|
|
@@ -17807,11 +17813,20 @@ declare namespace Office {
|
|
|
17807
17813
|
*
|
|
17808
17814
|
* **Errors**:
|
|
17809
17815
|
*
|
|
17810
|
-
*
|
|
17816
|
+
* If your call fails, use the {@link https://learn.microsoft.com/javascript/api/office/office.asyncresult#office-office-asyncresult-diagnostics-member | asyncResult.diagnostics}
|
|
17817
|
+
* property to view details about the error.
|
|
17818
|
+
*
|
|
17819
|
+
* - `GenericTokenError: An internal error has occurred.` - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens
|
|
17820
|
+
* for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the
|
|
17821
|
+
* {@link https://aka.ms/naafaq | FAQ page}.
|
|
17811
17822
|
*
|
|
17812
|
-
* - `
|
|
17823
|
+
* - `HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.`
|
|
17813
17824
|
*
|
|
17814
|
-
* - `
|
|
17825
|
+
* - `InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information.` - In Exchange Online environments,
|
|
17826
|
+
* this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in.
|
|
17827
|
+
* For guidance on how to implement NAA, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
17828
|
+
*
|
|
17829
|
+
* - `NetworkError: The user is no longer connected to the network. Please check your network connection and try again.`
|
|
17815
17830
|
*
|
|
17816
17831
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
|
|
17817
17832
|
* type `Office.AsyncResult`. The token is returned as a string in the `asyncResult.value` property.
|
|
@@ -17943,12 +17958,11 @@ declare namespace Office {
|
|
|
17943
17958
|
*
|
|
17944
17959
|
* **Important**:
|
|
17945
17960
|
*
|
|
17946
|
-
* - In
|
|
17961
|
+
* - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
|
|
17947
17962
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
|
|
17948
17963
|
* This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
|
|
17949
17964
|
* which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
|
|
17950
|
-
* Nested app authentication is the recommended approach for tokens going forward. For more information, see
|
|
17951
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
|
|
17965
|
+
* Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
17952
17966
|
*
|
|
17953
17967
|
* - The `getUserIdentityTokenAsync` method returns a token that you can use to identify and
|
|
17954
17968
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication | authenticate the add-in and user with an external system}.
|
|
@@ -17957,11 +17971,20 @@ declare namespace Office {
|
|
|
17957
17971
|
*
|
|
17958
17972
|
* **Errors**:
|
|
17959
17973
|
*
|
|
17960
|
-
*
|
|
17974
|
+
* If your call fails, use the {@link https://learn.microsoft.com/javascript/api/office/office.asyncresult#office-office-asyncresult-diagnostics-member | asyncResult.diagnostics}
|
|
17975
|
+
* property to view details about the error.
|
|
17976
|
+
*
|
|
17977
|
+
* - `GenericTokenError: An internal error has occurred.` - In Exchange Online environments, this error occurs when the token can't be retrieved because legacy Exchange tokens
|
|
17978
|
+
* for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in. For guidance on how to implement NAA, see the
|
|
17979
|
+
* {@link https://aka.ms/naafaq | FAQ page}.
|
|
17980
|
+
*
|
|
17981
|
+
* - `HTTPRequestFailure: The request has failed. Please look at the diagnostics object for the HTTP error code.`
|
|
17961
17982
|
*
|
|
17962
|
-
* - `InternalServerError
|
|
17983
|
+
* - `InternalServerError: The Exchange server returned an error. Please look at the diagnostics object for more information.` - In Exchange Online environments,
|
|
17984
|
+
* this error occurs when the token can't be retrieved because legacy Exchange tokens for Outlook add-ins are turned off. We recommend using NAA as a single sign-on solution for your add-in.
|
|
17985
|
+
* For guidance on how to implement NAA, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
17963
17986
|
*
|
|
17964
|
-
* - `NetworkError
|
|
17987
|
+
* - `NetworkError: The user is no longer connected to the network. Please check your network connection and try again.`
|
|
17965
17988
|
*
|
|
17966
17989
|
* @param callback - When the method completes, the function passed in the callback parameter is called with a single parameter of
|
|
17967
17990
|
* type `Office.AsyncResult`.
|
|
@@ -18054,12 +18077,11 @@ declare namespace Office {
|
|
|
18054
18077
|
*
|
|
18055
18078
|
* **Important**:
|
|
18056
18079
|
*
|
|
18057
|
-
* - In
|
|
18080
|
+
* - In February 2025, legacy Exchange {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#exchange-user-identity-token | user identity} and
|
|
18058
18081
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/authentication#callback-tokens | callback} tokens will be turned off by default for all Exchange Online tenants.
|
|
18059
18082
|
* This is part of {@link https://blogs.microsoft.com/on-the-issues/2023/11/02/secure-future-initiative-sfi-cybersecurity-cyberattacks/ | Microsoft's Secure Future Initiative},
|
|
18060
18083
|
* which gives organizations the tools needed to respond to the current threat landscape. Exchange user identity tokens will still work for Exchange on-premises.
|
|
18061
|
-
* Nested app authentication is the recommended approach for tokens going forward. For more information, see
|
|
18062
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | FAQ page}.
|
|
18084
|
+
* Nested app authentication (NAA) is the recommended approach for tokens going forward. For more information, see the {@link https://aka.ms/naafaq | FAQ page}.
|
|
18063
18085
|
*
|
|
18064
18086
|
* - To enable the `makeEwsRequestAsync` method to make EWS requests, the server administrator must set `OAuthAuthentication` to `true` on the
|
|
18065
18087
|
* Client Access Server EWS directory .
|
|
@@ -128798,99 +128820,85 @@ declare namespace PowerPoint {
|
|
|
128798
128820
|
/**
|
|
128799
128821
|
* The shape is a table.
|
|
128800
128822
|
* @remarks
|
|
128801
|
-
* [Api set: PowerPointApi
|
|
128802
|
-
* @beta
|
|
128823
|
+
* [Api set: PowerPointApi 1.4]
|
|
128803
128824
|
*/
|
|
128804
128825
|
table = "Table",
|
|
128805
128826
|
/**
|
|
128806
128827
|
* The shape is a callout.
|
|
128807
128828
|
* @remarks
|
|
128808
|
-
* [Api set: PowerPointApi
|
|
128809
|
-
* @beta
|
|
128829
|
+
* [Api set: PowerPointApi 1.4]
|
|
128810
128830
|
*/
|
|
128811
128831
|
callout = "Callout",
|
|
128812
128832
|
/**
|
|
128813
128833
|
* The shape is a chart.
|
|
128814
128834
|
* @remarks
|
|
128815
|
-
* [Api set: PowerPointApi
|
|
128816
|
-
* @beta
|
|
128835
|
+
* [Api set: PowerPointApi 1.4]
|
|
128817
128836
|
*/
|
|
128818
128837
|
chart = "Chart",
|
|
128819
128838
|
/**
|
|
128820
128839
|
* The shape is a content Office Add-in.
|
|
128821
128840
|
* @remarks
|
|
128822
|
-
* [Api set: PowerPointApi
|
|
128823
|
-
* @beta
|
|
128841
|
+
* [Api set: PowerPointApi 1.4]
|
|
128824
128842
|
*/
|
|
128825
128843
|
contentApp = "ContentApp",
|
|
128826
128844
|
/**
|
|
128827
128845
|
* The shape is a diagram.
|
|
128828
128846
|
* @remarks
|
|
128829
|
-
* [Api set: PowerPointApi
|
|
128830
|
-
* @beta
|
|
128847
|
+
* [Api set: PowerPointApi 1.4]
|
|
128831
128848
|
*/
|
|
128832
128849
|
diagram = "Diagram",
|
|
128833
128850
|
/**
|
|
128834
128851
|
* The shape is a freeform object.
|
|
128835
128852
|
* @remarks
|
|
128836
|
-
* [Api set: PowerPointApi
|
|
128837
|
-
* @beta
|
|
128853
|
+
* [Api set: PowerPointApi 1.4]
|
|
128838
128854
|
*/
|
|
128839
128855
|
freeform = "Freeform",
|
|
128840
128856
|
/**
|
|
128841
128857
|
* The shape is a graphic.
|
|
128842
128858
|
* @remarks
|
|
128843
|
-
* [Api set: PowerPointApi
|
|
128844
|
-
* @beta
|
|
128859
|
+
* [Api set: PowerPointApi 1.4]
|
|
128845
128860
|
*/
|
|
128846
128861
|
graphic = "Graphic",
|
|
128847
128862
|
/**
|
|
128848
128863
|
* The shape is an ink object.
|
|
128849
128864
|
* @remarks
|
|
128850
|
-
* [Api set: PowerPointApi
|
|
128851
|
-
* @beta
|
|
128865
|
+
* [Api set: PowerPointApi 1.4]
|
|
128852
128866
|
*/
|
|
128853
128867
|
ink = "Ink",
|
|
128854
128868
|
/**
|
|
128855
128869
|
* The shape is a media object.
|
|
128856
128870
|
* @remarks
|
|
128857
|
-
* [Api set: PowerPointApi
|
|
128858
|
-
* @beta
|
|
128871
|
+
* [Api set: PowerPointApi 1.4]
|
|
128859
128872
|
*/
|
|
128860
128873
|
media = "Media",
|
|
128861
128874
|
/**
|
|
128862
128875
|
* The shape is a 3D model.
|
|
128863
128876
|
* @remarks
|
|
128864
|
-
* [Api set: PowerPointApi
|
|
128865
|
-
* @beta
|
|
128877
|
+
* [Api set: PowerPointApi 1.4]
|
|
128866
128878
|
*/
|
|
128867
128879
|
model3D = "Model3D",
|
|
128868
128880
|
/**
|
|
128869
128881
|
* The shape is an OLE (Object Linking and Embedding) object.
|
|
128870
128882
|
* @remarks
|
|
128871
|
-
* [Api set: PowerPointApi
|
|
128872
|
-
* @beta
|
|
128883
|
+
* [Api set: PowerPointApi 1.4]
|
|
128873
128884
|
*/
|
|
128874
128885
|
ole = "Ole",
|
|
128875
128886
|
/**
|
|
128876
128887
|
* The shape is a placeholder.
|
|
128877
128888
|
* @remarks
|
|
128878
|
-
* [Api set: PowerPointApi
|
|
128879
|
-
* @beta
|
|
128889
|
+
* [Api set: PowerPointApi 1.4]
|
|
128880
128890
|
*/
|
|
128881
128891
|
placeholder = "Placeholder",
|
|
128882
128892
|
/**
|
|
128883
128893
|
* The shape is a SmartArt graphic.
|
|
128884
128894
|
* @remarks
|
|
128885
|
-
* [Api set: PowerPointApi
|
|
128886
|
-
* @beta
|
|
128895
|
+
* [Api set: PowerPointApi 1.4]
|
|
128887
128896
|
*/
|
|
128888
128897
|
smartArt = "SmartArt",
|
|
128889
128898
|
/**
|
|
128890
128899
|
* The shape is a text box.
|
|
128891
128900
|
* @remarks
|
|
128892
|
-
* [Api set: PowerPointApi
|
|
128893
|
-
* @beta
|
|
128901
|
+
* [Api set: PowerPointApi 1.4]
|
|
128894
128902
|
*/
|
|
128895
128903
|
textBox = "TextBox",
|
|
128896
128904
|
}
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.538",
|
|
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": "
|
|
49
|
+
"typesPublisherContentHash": "491324f80e6c4d4658d87f6dd8bafd6d8e9ba50df4013bec0ba092f12b3e590e",
|
|
50
50
|
"typeScriptVersion": "5.0",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|