[all hosts] Get latest (#2080)

OfficeDev · Oct 1, 2024 · 9bd2547 · 9bd2547
1 parent 0679ca5
commit 9bd2547
Show file tree

Hide file tree

Showing 11 changed files with 81 additions and 40 deletions.
diff --git a/docs/code-snippets/office-snippets.yaml b/docs/code-snippets/office-snippets.yaml
@@ -1191,7 +1191,7 @@ Office.Context#touchEnabled:member:
         // Add-in is running on an iPad.
         // Do something.
     }
-Office.context#ui:member:
+Office.Context#ui:member:
   - |-
     // Open a dialog and register an event handler.
     Office.context.ui.displayDialogAsync(

diff --git a/docs/docs-ref-autogen/office/office/office.context.yml b/docs/docs-ref-autogen/office/office/office.context.yml
@@ -711,6 +711,25 @@ properties:
       content: 'ui: UI;'
       return:
         type: '<xref uid="office!Office.UI:interface" />'
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          // Open a dialog and register an event handler.
+          Office.context.ui.displayDialogAsync(
+              "https://www.contoso.com/myDialog.html",
+              { height: 30, width: 20 },
+              (asyncResult) => {
+                  const dialog = asyncResult.value;
+                  dialog.addEventHandler(Office.EventType.DialogMessageReceived, (arg) => {
+                      dialog.close();
+                      processMessage(arg);
+                  });
+              }
+          );
+          ```
   - name: urls
     uid: 'office!Office.Context#urls:member'
     package: office!

diff --git a/docs/docs-ref-autogen/office_release/office/office.context.yml b/docs/docs-ref-autogen/office_release/office/office.context.yml
@@ -699,6 +699,25 @@ properties:
       content: 'ui: UI;'
       return:
         type: '<xref uid="office!Office.UI:interface" />'
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          // Open a dialog and register an event handler.
+          Office.context.ui.displayDialogAsync(
+              "https://www.contoso.com/myDialog.html",
+              { height: 30, width: 20 },
+              (asyncResult) => {
+                  const dialog = asyncResult.value;
+                  dialog.addEventHandler(Office.EventType.DialogMessageReceived, (arg) => {
+                      dialog.close();
+                      processMessage(arg);
+                  });
+              }
+          );
+          ```
   - name: urls
     uid: 'office!Office.Context#urls:member'
     package: office!

diff --git a/docs/docs-ref-autogen/outlook/outlook/office.smartalertseventcompletedoptions.yml b/docs/docs-ref-autogen/outlook/outlook/office.smartalertseventcompletedoptions.yml
@@ -137,8 +137,8 @@ properties:
       When you use the [completed
       method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))
       to signal completion of an event handler and set its `allowEvent` property to `false`<!-- -->, this property
-      specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts
-      dialog.
+      specifies the ID of the task pane or function that runs when the **Don't Send** button is selected from the
+      Smart Alerts dialog.
 
 
       For an example, see the [Smart Alerts
@@ -161,20 +161,21 @@ properties:
       **Important**:
 
 
-      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.
+      The `commandId` value must match the task pane or function ID specified in the manifest of your add-in. The markup
+      depends on the type of manifest your add-in uses.
 
 
       - **Add-in only manifest**: The `id` attribute of the
-      [Control](https://learn.microsoft.com/javascript/api/manifest/control) element representing the task pane.
+      [Control](https://learn.microsoft.com/javascript/api/manifest/control) element representing the task pane or
+      function.
 
 
-      - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the
-      "extensions.ribbons.tabs.groups.controls" array.
+      - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function 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.
+      If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or
+      function ID to the `commandId` option. Otherwise, the JSON data assigned to `contextData` is ignored.
     isPreview: false
     isDeprecated: false
     syntax:

diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.smartalertseventcompletedoptions.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.smartalertseventcompletedoptions.yml
@@ -137,8 +137,8 @@ properties:
       When you use the [completed
       method](https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))
       to signal completion of an event handler and set its `allowEvent` property to `false`<!-- -->, this property
-      specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts
-      dialog.
+      specifies the ID of the task pane or function that runs when the **Don't Send** button is selected from the
+      Smart Alerts dialog.
 
 
       For an example, see the [Smart Alerts
@@ -161,19 +161,21 @@ properties:
       **Important**:
 
 
-      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.
+      The `commandId` value must match the task pane or function ID specified in the manifest of your add-in. The markup
+      depends on the type of manifest your add-in uses.
 
 
       - **Add-in only manifest**: The `id` attribute of the
-      [Control](https://learn.microsoft.com/javascript/api/manifest/control) element representing the task pane.
+      [Control](https://learn.microsoft.com/javascript/api/manifest/control) element representing the task pane or
+      function.
 
 
-      - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "controls" array.
+      - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function 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.
+      If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or
+      function ID to the `commandId` option. Otherwise, the JSON data assigned to `contextData` is ignored.
     isPreview: false
     isDeprecated: false
     syntax:

diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv
@@ -6741,7 +6741,7 @@ Office.Context,"requirements",Property,Fine,true
 Office.Context,"roamingSettings",Property,Good,true
 Office.Context,"sensitivityLabelsCatalog",Property,Good,true
 Office.Context,"touchEnabled",Property,Good,true
-Office.Context,"ui",Property,Fine,false
+Office.Context,"ui",Property,Fine,true
 Office.Context,"urls",Property,Good,true
 Office.ContextInformation,N/A,Class,Good,false
 Office.ContextInformation,"host",Property,Fine,true

diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts
@@ -11827,7 +11827,7 @@ export declare namespace Office {
         cancelLabel?: string;
         /**
          * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
-         * this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
+         * this property specifies the ID of the task pane or function that runs when the **Don't Send** button is selected from the Smart Alerts dialog.
          *
          * For an example, see the
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
@@ -11842,14 +11842,14 @@ export declare namespace Office {
          *
          * **Important**:
          *
-         * 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
+         * The `commandId` value must match the task pane or function ID specified in the manifest of your add-in. The markup depends on the type of manifest your
          * add-in uses.
          *
-         * - **Add-in only 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 or function.
          *
-         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "controls" array.
+         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function 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.
+         * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or function ID to the `commandId` option.
          * Otherwise, the JSON data assigned to `contextData` is ignored.
          */
         commandId?: string;

diff --git a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts
@@ -12135,7 +12135,7 @@ export declare namespace Office {
         cancelLabel?: string;
         /**
          * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
-         * this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
+         * this property specifies the ID of the task pane or function that runs when the **Don't Send** button is selected from the Smart Alerts dialog.
          *
          * For an example, see the
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
@@ -12150,14 +12150,14 @@ export declare namespace Office {
          *
          * **Important**:
          *
-         * 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
+         * The `commandId` value must match the task pane or function ID specified in the manifest of your add-in. The markup depends on the type of manifest your
          * add-in uses.
          *
-         * - **Add-in only 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 or function.
          *
-         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "extensions.ribbons.tabs.groups.controls" array.
+         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function 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.
+         * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or function ID to the `commandId` option.
          * Otherwise, the JSON data assigned to `contextData` is ignored.
          */
         commandId?: string;

diff --git a/generate-docs/script-inputs/local-repo-snippets.yaml b/generate-docs/script-inputs/local-repo-snippets.yaml
@@ -2732,7 +2732,7 @@ Office.Context#touchEnabled:member:
         // Add-in is running on an iPad.
         // Do something.
     }
-Office.context#ui:member:
+Office.Context#ui:member:
   - |-
     // Open a dialog and register an event handler.
     Office.context.ui.displayDialogAsync(

diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts
@@ -20568,7 +20568,7 @@ declare namespace Office {
         cancelLabel?: string;
         /**
          * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
-         * this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
+         * this property specifies the ID of the task pane or function that runs when the **Don't Send** button is selected from the Smart Alerts dialog.
          *
          * For an example, see the
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
@@ -20583,14 +20583,14 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * 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
+         * The `commandId` value must match the task pane or function ID specified in the manifest of your add-in. The markup depends on the type of manifest your
          * add-in uses.
          *
-         * - **Add-in only 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 or function.
          *
-         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "controls" array.
+         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function 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.
+         * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or function ID to the `commandId` option.
          * Otherwise, the JSON data assigned to `contextData` is ignored.
          */
         commandId?: string;

diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts
@@ -20928,7 +20928,7 @@ declare namespace Office {
         cancelLabel?: string;
         /**
          * When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,
-         * this property specifies the ID of the task pane that opens when the **Don't Send** button is selected from the Smart Alerts dialog.
+         * this property specifies the ID of the task pane or function that runs when the **Don't Send** button is selected from the Smart Alerts dialog.
          *
          * For an example, see the
          * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough#customize-the-dont-send-button-optional | Smart Alerts walkthrough}.
@@ -20943,14 +20943,14 @@ declare namespace Office {
          *
          * **Important**:
          *
-         * 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
+         * The `commandId` value must match the task pane or function ID specified in the manifest of your add-in. The markup depends on the type of manifest your
          * add-in uses.
          *
-         * - **Add-in only 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 or function.
          *
-         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane command in the "extensions.ribbons.tabs.groups.controls" array.
+         * - **Unified manifest for Microsoft 365**: The "id" property of the task pane or function 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.
+         * If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane or function ID to the `commandId` option.
          * Otherwise, the JSON data assigned to `contextData` is ignored.
          */
         commandId?: string;