@types/office-js-preview 1.0.355 → 1.0.357

office-js-preview/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-preview.
 
 ### Additional Details
- * Last updated: Thu, 17 Nov 2022 00:03:04 GMT
+ * Last updated: Thu, 01 Dec 2022 21:32:57 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -10386,13 +10386,12 @@ declare namespace Office {
          *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property.
          */
-        getInitializationContextAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
          *
@@ -10403,13 +10402,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
          *
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property.
          */
-        getInitializationContextAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Asynchronously gets the ID of a saved item.
          *
@@ -11726,13 +11724,12 @@ declare namespace Office {
          *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property.
          */
-        getInitializationContextAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
          *
@@ -11743,13 +11740,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
          *
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property.
          */
-        getInitializationContextAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
          *
@@ -15605,13 +15601,12 @@ declare namespace Office {
          *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property..
          */
-        getInitializationContextAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
          *
@@ -15622,13 +15617,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
          *
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property.
          */
-        getInitializationContextAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Asynchronously gets the ID of a saved item.
          *
@@ -16873,13 +16867,12 @@ declare namespace Office {
          *
          * @param options - An object literal that contains one or more of the following properties:-
          *        `asyncContext`: Developers can provide any object they wish to access in the callback function.
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property.
          */
-        getInitializationContextAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.
          *
@@ -16890,13 +16883,12 @@ declare namespace Office {
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
          *
-         * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
-         *                             of type `Office.AsyncResult`.
-         *                 On success, the initialization context data is provided in the `asyncResult.value` property as a string.
-         *                 If there is no initialization context, the `asyncResult` object will contain
-         *                 an `Error` object with its `code` property set to 9020 and its `name` property set to `GenericResponseError`.
+         * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter
+         *                 of type `Office.AsyncResult`.
+         *                 On success, the initialization context data is provided as a string (or an empty string if there's no initialization context)
+         *                 in the `asyncResult.value` property.
          */
-        getInitializationContextAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
+        getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
          * Returns string values in the selected item that match the regular expressions defined in the manifest XML file.
          *
@@ -35559,7 +35551,8 @@ declare namespace Excel {
          */
         readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
         /**
-         * Represents the value computed by the name's formula. For a named range, will return the range address.
+         * Represents the value computed by the name's formula. For a named range it will return the range address.
+         * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
          *
          * @remarks
          * [Api set: ExcelApi 1.1]
@@ -69446,7 +69439,8 @@ declare namespace Excel {
              */
             type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
             /**
-             * Represents the value computed by the name's formula. For a named range, will return the range address.
+             * Represents the value computed by the name's formula. For a named range it will return the range address.
+             * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -76978,7 +76972,8 @@ declare namespace Excel {
              */
             type?: boolean;
             /**
-             * For EACH ITEM in the collection: Represents the value computed by the name's formula. For a named range, will return the range address.
+             * For EACH ITEM in the collection: Represents the value computed by the name's formula. For a named range it will return the range address.
+             * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -77080,6 +77075,7 @@ declare namespace Excel {
             type?: boolean;
             /**
              * Represents the value computed by the name's formula. For a named range, will return the range address.
+             * Note: This API returns the #VALUE! error in the Excel UI if it refers to a custom function.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.355",
+    "version": "1.0.357",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "8694a0305ae64b82c2884086cdd9105a0304e7c1124d0ddccd90803f962a0d52",
+    "typesPublisherContentHash": "79c293a1b5055bb080cf14036c0ff6895c7a096d23f9d6e112cd61ff35b7be00",
     "typeScriptVersion": "4.2"
 }