@types/office-js 1.0.407 → 1.0.408

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: Thu, 01 Aug 2024 19:07:04 GMT
+ * Last updated: Tue, 06 Aug 2024 17:36:11 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -3137,7 +3137,7 @@ declare namespace Office {
         /**
          * Associates the ID or name of an action with a function.
          * 
-         * @param actionId The ID of an action that is defined in an extended manifest or the name of the function as specified in a **FunctionName** element in the manifest.
+         * @param actionId The ID of an action that is defined in the manifest.
          * @param actionFunction The function that is run when the action is invoked. 
          */
         associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
@@ -3152,14 +3152,14 @@ declare namespace Office {
          * 
          * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
          * 
-         * @param shortcuts An object of custom shortcuts with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}`.
+         * @param shortcuts An object of custom shortcuts with keys being the IDs of the actions and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}`.
          * To learn how to specify a valid action ID and a key combination, see {@link https://learn.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts | Add custom keyboard shortcuts to your Office Add-ins}. (Note that a key combination can be `null`, in which case, the action keeps the key combination specified in the JSON file.)
          * @returns A promise that resolves when every custom shortcut assignment in `shortcuts` has been registered. Even if there is a conflict with existing shortcuts, the customized shortcut will be registered.
          * Otherwise, the promise will be rejected with error code and error message. An "InvalidOperation" error code is returned if any action ID in `shortcuts` does not exist, or if shortcut combination is invalid.
          */
         replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;
         /**
-         * Gets the existing shortcuts for the add-in. The set always includes (1) the shortcuts defined in the add-in's extended manifest for keyboard shortcuts and (2) the current user's custom shortcuts if those exist.
+         * Gets the existing shortcuts for the add-in. The set always includes (1) the shortcuts defined in the add-in's manifest for keyboard shortcuts and (2) the current user's custom shortcuts if those exist.
          * The shortcut can be `null` if it conflicts with the shortcut of another add-in or with the Office application. Specifically, it would be `null` if, when prompted to choose which shortcut to use, the user didn't choose the action of the current add-in. For more information about conflicts with shortcuts, see  {@link https://learn.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts#avoid-key-combinations-in-use-by-other-add-ins | Avoid key combinations in use by other add-ins}.
          *
          * @remarks
@@ -3170,7 +3170,7 @@ declare namespace Office {
          *
          * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
          *
-         * @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions (as defined in an extended manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
+         * @returns A promise that resolves to an object of shortcuts, with keys being the IDs of the actions (as defined in an manifest) and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2", "SetUnderline": null}`.
          */
         getShortcuts(): Promise<{[actionId: string]: string|null}>;
         /**
@@ -8440,7 +8440,7 @@ declare namespace Office {
          * This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
          * for Outlook. For more on how to specify a requirement set in your manifest, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | Specify Office applications and API requirements},
-         * if you're using the XML manifest. If you're using the unified manifest for Microsoft 365, see
+         * if you're using the add-in only manifest. If you're using the unified manifest for Microsoft 365, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | Office Add-ins with the unified app manifest for Microsoft 365}.
          *
          * The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
@@ -8543,7 +8543,7 @@ declare namespace Office {
          * This method is available in the DialogApi requirement set for Excel, PowerPoint, or Word add-ins, and in the Mailbox requirement set 1.4
          * for Outlook. For more on how to specify a requirement set in your manifest, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/develop/specify-office-hosts-and-api-requirements | Specify Office applications and API requirements},
-         * if you're using the XML manifest. If you're using the unified manifest for Microsoft 365, see
+         * if you're using the add-in only manifest. If you're using the unified manifest for Microsoft 365, see
          * {@link https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview | Office Add-ins with the unified app manifest for Microsoft 365}.
          *
          * The initial page must be on the same domain as the parent page (the startAddress parameter). After the initial page loads, you can go to
@@ -8712,7 +8712,7 @@ declare namespace Office {
          * this API isn't supported in add-ins that implement a task pane. On these clients, the API is only supported in add-ins that implement event-based activation
          * or integrated spam reporting.
          *
-         * - If your add-in uses the XML manifest, the URL returned matches the `resid` value of the **RuntimeOverride** element of type `javascript`.
+         * - If your add-in uses the add-in only manifest, the URL returned matches the `resid` value of the **RuntimeOverride** element of type `javascript`.
          * To learn more, see {@link https://learn.microsoft.com/javascript/api/manifest/override#override-element-for-runtime | Override element for Runtime}.
          *
          * - If your add-in uses the unified manifest for Microsoft 365, the URL returned matches the value of the `script` property in the
@@ -12092,7 +12092,7 @@ declare namespace Office {
          */
         getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
         /**
-         * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
+         * Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.
          *
          * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
          * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
@@ -12103,7 +12103,7 @@ declare namespace Office {
          *
          * @returns
          * The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
-         * manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
+         * add-in manifest file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
          * `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
          * `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
          *
@@ -12152,10 +12152,10 @@ declare namespace Office {
          */
         getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
+         * Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.
          *
          * @returns
-         * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
+         * An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
          * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
          * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
          * of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
@@ -12186,10 +12186,10 @@ declare namespace Office {
          */
         getRegExMatches(): any;
         /**
-         * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
+         * Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.
          *
          * @returns
-         * An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest XML file,
+         * An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the add-in manifest file,
          * with the specified `RegExName` element value.
          *
          * @remarks
@@ -12240,11 +12240,11 @@ declare namespace Office {
          */
         getSelectedEntities(): Entities;
         /**
-         * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
+         * Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.
          * Highlighted matches apply to contextual add-ins.
          *
          * @returns
-         * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
+         * An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
          * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
          * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
          * The `PropertyName` simple type defines the supported properties.
@@ -18135,7 +18135,7 @@ declare namespace Office {
          */
         getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;
         /**
-         * Returns well-known entities in the selected item that pass the named filter defined in an XML manifest file.
+         * Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.
          *
          * **Warning**: Entity-based contextual Outlook add-ins are now retired. However, regular expression rules are still supported.
          * We recommend updating your contextual add-in to use regular expression rules as an alternative solution.
@@ -18146,7 +18146,7 @@ declare namespace Office {
          *
          * @returns
          * The entities that match the regular expression defined in the `ItemHasKnownEntity` rule element in the
-         * manifest XML file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
+         * add-in manifest file with the specified `FilterName` element value. If there's no `ItemHasKnownEntity` element in the manifest with a
          * `FilterName` element value that matches the `name` parameter, the method returns `null`. If the `name` parameter matches an
          * `ItemHasKnownEntity` element in the manifest, but there are no entities in the current item that match, the method returns an empty array.
          *
@@ -18195,10 +18195,10 @@ declare namespace Office {
          */
         getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Returns string values in the selected item that match the regular expressions defined in an XML manifest file.
+         * Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.
          *
          * @returns
-         * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
+         * An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
          * The name of each array is equal to the corresponding value of the RegExName attribute of the matching `ItemHasRegularExpressionMatch` rule.
          * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property
          * of the item that's specified by that rule. The `PropertyName` simple type defines the supported properties.
@@ -18229,10 +18229,10 @@ declare namespace Office {
          */
         getRegExMatches(): any;
         /**
-         * Returns string values in the selected item that match the named regular expression defined in an XML manifest file.
+         * Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.
          *
          * @returns
-         * An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the manifest XML file,
+         * An array that contains the strings that match the regular expression defined in the `ItemHasRegularExpressionMatch` rule element in the add-in manifest file,
          * with the specified `RegExName` element value.
          *
          * @remarks
@@ -18283,11 +18283,11 @@ declare namespace Office {
          */
         getSelectedEntities(): Entities;
         /**
-         * Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.
+         * Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.
          * Highlighted matches apply to contextual add-ins.
          *
          * @returns
-         * An object that contains arrays of strings that match the regular expressions defined in the manifest XML file.
+         * An object that contains arrays of strings that match the regular expressions defined in the add-in manifest file.
          * The name of each array is equal to the corresponding value of the `RegExName` attribute of the matching `ItemHasRegularExpressionMatch` rule.
          * For an `ItemHasRegularExpressionMatch` rule, a matching string has to occur in the property of the item that's specified by that rule.
          * The `PropertyName` simple type defines the supported properties.
@@ -20447,9 +20447,9 @@ declare namespace Office {
          * The `commandId` value must match the task pane ID specified in the manifest of your add-in. The markup depends on the type of manifest your
          * add-in uses.
          *
-         * - **XML manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane.
+         * - **Add-in only manifest**: The `id` attribute of the {@link https://learn.microsoft.com/javascript/api/manifest/control | Control} element representing the task pane.
          *
-         * - **Unified manifest for Microsoft 365 (preview)**: The "id" property of the task pane command in the "controls" array.
+         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "controls" array.
          *
          * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
          * Otherwise, the JSON data assigned to `contextData` is ignored.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.407",
+    "version": "1.0.408",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "3be230465bfcb2311397b01307aa15c7a05cad1948c8d993782b7d12eecf8542",
+    "typesPublisherContentHash": "d814d45d3ea73b6e8513036e038b2eb8548a88744614d9a04c9bf27c15be131b",
     "typeScriptVersion": "4.8"
 }