@types/office-js 1.0.467 → 1.0.469

office-js/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
 
 ### Additional Details
- * Last updated: Fri, 14 Feb 2025 21:32:13 GMT
+ * Last updated: Thu, 20 Feb 2025 18:37:24 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -10595,9 +10595,6 @@ declare namespace Office {
          *
          * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
          *
-         * **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.
-         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
-         *
          * @remarks
          * [Api set: Mailbox 1.8]
          *
@@ -10605,6 +10602,18 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
          *
+         * **Important**:
+         *
+         * - 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.
+         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
+         *
+         * - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
+         * If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
+         * Otherwise, the image won't render in the body once it's inserted. For an example, see the
+         * {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
+         * sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
+         *
          * **Errors**:
          *
          * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
@@ -10613,11 +10622,6 @@ declare namespace Office {
          *
          * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
          *
-         * **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
-         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
-         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
-         * 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}.
-         *
          * @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).
          * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
          * @param options - An object literal that contains one or more of the following properties:-
@@ -10638,9 +10642,6 @@ declare namespace Office {
          *
          * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
          *
-         * **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.
-         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
-         *
          * @remarks
          * [Api set: Mailbox 1.8]
          *
@@ -10648,6 +10649,18 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
          *
+         * **Important**:
+         *
+         * - 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.
+         * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
+         *
+         * - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
+         * If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
+         * Otherwise, the image won't render in the body once it's inserted. For an example, see the
+         * {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
+         * sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
+         *
          * **Errors**:
          *
          * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
@@ -10656,11 +10669,6 @@ declare namespace Office {
          *
          * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
          *
-         * **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
-         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
-         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
-         * 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}.
-         * 
          * @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).
          * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
          * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
@@ -16623,10 +16631,12 @@ declare namespace Office {
          * - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
          * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
          *
-         * - 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
-         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
-         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
-         * 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}.
+         * - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
+         * If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
+         * Otherwise, the image won't render in the body once it's inserted. For an example, see the
+         * {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
+         * sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
          *
          * **Errors**:
          *
@@ -16669,10 +16679,12 @@ declare namespace Office {
          * - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
          * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
          *
-         * - 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
-         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync} 
-         * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
-         * 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}.
+         * - To add an inline Base64-encoded image to the body of a message or appointment being composed, use the
+         * {@link https://learn.microsoft.com/javascript/api/outlook/office.body| Body API} methods, such as `prependAsync`, `setSignatureAsync`, or `setAsync`.
+         * If you use `Office.context.mailbox.item.body.setAsync` to insert the image, first call `Office.context.mailbox.item.body.getAsync` to get the current body of the item.
+         * Otherwise, the image won't render in the body once it's inserted. For an example, see the
+         * {@link https://raw.githubusercontent.com/OfficeDev/office-js-snippets/refs/heads/main/samples/outlook/20-item-body/add-inline-base64-image.yaml | Add inline Base64-encoded image to message or appointment body (Compose)}
+         * sample in {@link https://learn.microsoft.com/office/dev/add-ins/overview/explore-with-script-lab | Script Lab}.
          *
          * **Errors**:
          *
@@ -86545,7 +86557,7 @@ declare namespace Word {
          */
         untrack(): Word.CritiqueAnnotation;
         /**
-         * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
+         * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
          * Whereas the original `Word.CritiqueAnnotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CritiqueAnnotationData`) that contains shallow copies of any loaded child properties from the original object.
          */
         toJSON(): Word.Interfaces.CritiqueAnnotationData;
@@ -86658,7 +86670,7 @@ declare namespace Word {
          */
         untrack(): Word.Annotation;
         /**
-         * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
+         * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
          * Whereas the original `Word.Annotation` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.AnnotationData`) that contains shallow copies of any loaded child properties from the original object.
          */
         toJSON(): Word.Interfaces.AnnotationData;

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.467",
+    "version": "1.0.469",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -46,6 +46,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "b480ef645ee3d623e1c783336eed22d096a7b30a3a62b8a7985d2d7311af05a0",
+    "typesPublisherContentHash": "90c886cff7229a7fc1b7d2e701d34bf97f251a8b9e7fa1a2edbf331aa2f8165e",
     "typeScriptVersion": "5.0"
 }