@types/office-js 1.0.314 → 1.0.316
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 +1 -1
- office-js/index.d.ts +54 -72
- office-js/package.json +2 -2
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:
|
|
11
|
+
* Last updated: Tue, 28 Feb 2023 21:32:42 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
|
@@ -239,20 +239,17 @@ declare namespace Office {
|
|
|
239
239
|
*
|
|
240
240
|
* **Support details**
|
|
241
241
|
*
|
|
242
|
-
* A capital Y in the following matrix indicates that this object is supported in the corresponding Office application.
|
|
243
|
-
* An empty cell indicates that the Office application doesn't support this object.
|
|
244
|
-
*
|
|
245
242
|
* For more information about Office application and server requirements, see
|
|
246
243
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
247
244
|
*
|
|
248
245
|
* *Supported applications, by platform*
|
|
249
246
|
* <table>
|
|
250
247
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
251
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
252
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
253
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
254
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
255
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
248
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
249
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
250
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
251
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> Supported </td></tr>
|
|
252
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
256
253
|
* </table>
|
|
257
254
|
*/
|
|
258
255
|
var context: Context;
|
|
@@ -274,20 +271,17 @@ declare namespace Office {
|
|
|
274
271
|
*
|
|
275
272
|
* **Support details**
|
|
276
273
|
*
|
|
277
|
-
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office application.
|
|
278
|
-
* An empty cell indicates that the Office application doesn't support this function.
|
|
279
|
-
*
|
|
280
274
|
* For more information about Office application and server requirements, see
|
|
281
275
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
282
276
|
*
|
|
283
277
|
* *Supported applications, by platform*
|
|
284
278
|
* <table>
|
|
285
279
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
286
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
287
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
288
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
289
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
290
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
280
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
281
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
282
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
283
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> Supported </td></tr>
|
|
284
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
291
285
|
* </table>
|
|
292
286
|
*
|
|
293
287
|
* @param reason Indicates how the app was initialized.
|
|
@@ -311,20 +305,17 @@ declare namespace Office {
|
|
|
311
305
|
*
|
|
312
306
|
* **Support details**
|
|
313
307
|
*
|
|
314
|
-
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office application.
|
|
315
|
-
* An empty cell indicates that the Office application doesn't support this function.
|
|
316
|
-
*
|
|
317
308
|
* For more information about Office application and server requirements, see
|
|
318
309
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
319
310
|
*
|
|
320
311
|
* *Supported applications, by platform*
|
|
321
312
|
* <table>
|
|
322
313
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
323
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
324
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
325
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
326
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
327
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
314
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
315
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
316
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
317
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> </td></tr>
|
|
318
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
328
319
|
* </table>
|
|
329
320
|
*
|
|
330
321
|
* @param useShortNamespace True to use the shortcut alias; otherwise false to disable it. The default is true.
|
|
@@ -869,20 +860,17 @@ declare namespace Office {
|
|
|
869
860
|
*
|
|
870
861
|
* **Support details**
|
|
871
862
|
*
|
|
872
|
-
* A capital Y in the following matrix indicates that this property is supported in the corresponding Office application.
|
|
873
|
-
* An empty cell indicates that the Office application doesn't support this property.
|
|
874
|
-
*
|
|
875
863
|
* For more information about Office application and server requirements, see
|
|
876
864
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
877
865
|
*
|
|
878
866
|
* *Supported applications, by platform*
|
|
879
867
|
* <table>
|
|
880
868
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
881
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
882
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
883
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
884
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
885
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
869
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
870
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
871
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
872
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> </td></tr>
|
|
873
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
886
874
|
* </table>
|
|
887
875
|
*/
|
|
888
876
|
contentLanguage: string;
|
|
@@ -910,20 +898,17 @@ declare namespace Office {
|
|
|
910
898
|
*
|
|
911
899
|
* **Support details**
|
|
912
900
|
*
|
|
913
|
-
* A capital Y in the following matrix indicates that this property is supported in the corresponding Office application.
|
|
914
|
-
* An empty cell indicates that the Office application doesn't support this property.
|
|
915
|
-
*
|
|
916
901
|
* For more information about Office application and server requirements, see
|
|
917
902
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
918
903
|
*
|
|
919
904
|
* *Supported applications, by platform*
|
|
920
905
|
* <table>
|
|
921
906
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
922
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
923
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
924
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
925
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
926
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
907
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
908
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
909
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
910
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> Supported </td></tr>
|
|
911
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
927
912
|
* </table>
|
|
928
913
|
*/
|
|
929
914
|
displayLanguage: string;
|
|
@@ -1989,10 +1974,10 @@ declare namespace Office {
|
|
|
1989
1974
|
* *Supported applications, by platform*
|
|
1990
1975
|
* <table>
|
|
1991
1976
|
* <tr><th> </th><th> Office on Windows </th><th> Office on the web </th></tr>
|
|
1992
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
1977
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> </td></tr>
|
|
1993
1978
|
* <tr><td><strong> Outlook </strong></td><td> Preview </td><td> </td></tr>
|
|
1994
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
1995
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
1979
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> </td></tr>
|
|
1980
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td></tr>
|
|
1996
1981
|
* </table>
|
|
1997
1982
|
*/
|
|
1998
1983
|
interface OfficeTheme {
|
|
@@ -2073,17 +2058,14 @@ declare namespace Office {
|
|
|
2073
2058
|
*
|
|
2074
2059
|
* **Support details**
|
|
2075
2060
|
*
|
|
2076
|
-
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office application.
|
|
2077
|
-
* An empty cell indicates that the Office application doesn't support this function.
|
|
2078
|
-
*
|
|
2079
2061
|
* For more information about Office application and server requirements, see
|
|
2080
2062
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
2081
2063
|
*
|
|
2082
2064
|
* *Supported applications, by platform*
|
|
2083
2065
|
* <table>
|
|
2084
2066
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th></tr>
|
|
2085
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
2086
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
2067
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
2068
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
2087
2069
|
* </table>
|
|
2088
2070
|
*/
|
|
2089
2071
|
function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;
|
|
@@ -9939,13 +9921,13 @@ declare namespace Office {
|
|
|
9939
9921
|
/**
|
|
9940
9922
|
* Adds a file to a message or appointment as an attachment.
|
|
9941
9923
|
*
|
|
9942
|
-
* The `addFileAttachmentFromBase64Async` method uploads the file from the
|
|
9924
|
+
* The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
|
|
9943
9925
|
* This method returns the attachment identifier in the `asyncResult.value` object.
|
|
9944
9926
|
*
|
|
9945
9927
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
9946
9928
|
*
|
|
9947
9929
|
* **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
9948
|
-
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of
|
|
9930
|
+
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
9949
9931
|
*
|
|
9950
9932
|
* @remarks
|
|
9951
9933
|
* [Api set: Mailbox 1.8]
|
|
@@ -9958,16 +9940,16 @@ declare namespace Office {
|
|
|
9958
9940
|
*
|
|
9959
9941
|
* - `AttachmentSizeExceeded`: The attachment is larger than allowed.
|
|
9960
9942
|
*
|
|
9961
|
-
* - `FileTypeNotSupported`: The attachment has an extension that
|
|
9943
|
+
* - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
|
|
9962
9944
|
*
|
|
9963
9945
|
* - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
|
|
9964
9946
|
*
|
|
9965
|
-
* **Note**: If you're adding an inline
|
|
9947
|
+
* **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
|
|
9966
9948
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
|
|
9967
|
-
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image
|
|
9949
|
+
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
|
|
9968
9950
|
* For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
|
|
9969
9951
|
*
|
|
9970
|
-
* @param base64File - The
|
|
9952
|
+
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
9971
9953
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
9972
9954
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
9973
9955
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -9983,13 +9965,13 @@ declare namespace Office {
|
|
|
9983
9965
|
/**
|
|
9984
9966
|
* Adds a file to a message or appointment as an attachment.
|
|
9985
9967
|
*
|
|
9986
|
-
* The `addFileAttachmentFromBase64Async` method uploads the file from the
|
|
9968
|
+
* The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
|
|
9987
9969
|
* This method returns the attachment identifier in the `asyncResult.value` object.
|
|
9988
9970
|
*
|
|
9989
9971
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
9990
9972
|
*
|
|
9991
9973
|
* **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
9992
|
-
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of
|
|
9974
|
+
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
9993
9975
|
*
|
|
9994
9976
|
* @remarks
|
|
9995
9977
|
* [Api set: Mailbox 1.8]
|
|
@@ -10002,16 +9984,16 @@ declare namespace Office {
|
|
|
10002
9984
|
*
|
|
10003
9985
|
* - `AttachmentSizeExceeded`: The attachment is larger than allowed.
|
|
10004
9986
|
*
|
|
10005
|
-
* - `FileTypeNotSupported`: The attachment has an extension that
|
|
9987
|
+
* - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
|
|
10006
9988
|
*
|
|
10007
9989
|
* - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
|
|
10008
9990
|
*
|
|
10009
|
-
* **Note**: If you're adding an inline
|
|
9991
|
+
* **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
|
|
10010
9992
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
|
|
10011
|
-
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image
|
|
9993
|
+
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
|
|
10012
9994
|
* For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
|
|
10013
9995
|
*
|
|
10014
|
-
* @param base64File - The
|
|
9996
|
+
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
10015
9997
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
10016
9998
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
|
|
10017
9999
|
* of type `Office.AsyncResult`.
|
|
@@ -14991,13 +14973,13 @@ declare namespace Office {
|
|
|
14991
14973
|
/**
|
|
14992
14974
|
* Adds a file to a message or appointment as an attachment.
|
|
14993
14975
|
*
|
|
14994
|
-
* The `addFileAttachmentFromBase64Async` method uploads the file from the
|
|
14976
|
+
* The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
|
|
14995
14977
|
* This method returns the attachment identifier in the `asyncResult.value` object.
|
|
14996
14978
|
*
|
|
14997
14979
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
14998
14980
|
*
|
|
14999
14981
|
* **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
15000
|
-
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of
|
|
14982
|
+
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
15001
14983
|
*
|
|
15002
14984
|
* @remarks
|
|
15003
14985
|
* [Api set: Mailbox 1.8]
|
|
@@ -15010,16 +14992,16 @@ declare namespace Office {
|
|
|
15010
14992
|
*
|
|
15011
14993
|
* - `AttachmentSizeExceeded`: The attachment is larger than allowed.
|
|
15012
14994
|
*
|
|
15013
|
-
* - `FileTypeNotSupported`: The attachment has an extension that
|
|
14995
|
+
* - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
|
|
15014
14996
|
*
|
|
15015
14997
|
* - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
|
|
15016
14998
|
*
|
|
15017
|
-
* **Note**: If you're adding an inline
|
|
14999
|
+
* **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
|
|
15018
15000
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
|
|
15019
|
-
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image
|
|
15001
|
+
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
|
|
15020
15002
|
* For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
|
|
15021
15003
|
*
|
|
15022
|
-
* @param base64File - The
|
|
15004
|
+
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
15023
15005
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
15024
15006
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
15025
15007
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
@@ -15032,13 +15014,13 @@ declare namespace Office {
|
|
|
15032
15014
|
/**
|
|
15033
15015
|
* Adds a file to a message or appointment as an attachment.
|
|
15034
15016
|
*
|
|
15035
|
-
* The `addFileAttachmentFromBase64Async` method uploads the file from the
|
|
15017
|
+
* The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
|
|
15036
15018
|
* This method returns the attachment identifier in the `asyncResult.value` object.
|
|
15037
15019
|
*
|
|
15038
15020
|
* You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
|
|
15039
15021
|
*
|
|
15040
15022
|
* **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
|
|
15041
|
-
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of
|
|
15023
|
+
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
15042
15024
|
*
|
|
15043
15025
|
* @remarks
|
|
15044
15026
|
* [Api set: Mailbox 1.8]
|
|
@@ -15051,16 +15033,16 @@ declare namespace Office {
|
|
|
15051
15033
|
*
|
|
15052
15034
|
* - `AttachmentSizeExceeded`: The attachment is larger than allowed.
|
|
15053
15035
|
*
|
|
15054
|
-
* - `FileTypeNotSupported`: The attachment has an extension that
|
|
15036
|
+
* - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
|
|
15055
15037
|
*
|
|
15056
15038
|
* - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
|
|
15057
15039
|
*
|
|
15058
|
-
* **Note**: If you're adding an inline
|
|
15040
|
+
* **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
|
|
15059
15041
|
* {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
|
|
15060
|
-
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image
|
|
15042
|
+
* method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
|
|
15061
15043
|
* For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
|
|
15062
15044
|
*
|
|
15063
|
-
* @param base64File - The
|
|
15045
|
+
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
15064
15046
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
15065
15047
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
15066
15048
|
* type Office.AsyncResult. On success, the attachment identifier will be provided in the `asyncResult.value` property.
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.316",
|
|
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": "
|
|
48
|
+
"typesPublisherContentHash": "13d21fe2eb5ddeae15c8ee9dfcef62fdc9a9f904327153e0c582813a88bf70be",
|
|
49
49
|
"typeScriptVersion": "4.2"
|
|
50
50
|
}
|