From ed3b07d824a85ec44cb7f956fa14d327a3670e93 Mon Sep 17 00:00:00 2001 From: Elizabeth Samuel Date: Tue, 8 Oct 2024 08:26:35 -0700 Subject: [PATCH] Automatically generated docs (#2089) * Automatically generated docs * Updates from snippets --------- Co-authored-by: github-actions --- .../office/office/office.dialog.yml | 3 +++ .../office/office/office.ui.yml | 6 +++++ .../office_release/office/office.dialog.yml | 3 +++ .../office_release/office/office.ui.yml | 6 +++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ .../outlook/office.sharedproperties.yml | 23 ++++++++++++++++++ generate-docs/API Coverage Report.csv | 4 ++-- .../office.d.ts | 24 ++++++++++++------- .../api-extractor-inputs-office/office.d.ts | 24 ++++++++++++------- generate-docs/script-inputs/office.d.ts | 24 ++++++++++++------- .../script-inputs/office_preview.d.ts | 24 ++++++++++++------- .../script-inputs/script-lab-snippets.yaml | 16 +++++++++++++ 18 files changed, 280 insertions(+), 38 deletions(-) diff --git a/docs/docs-ref-autogen/office/office/office.dialog.yml b/docs/docs-ref-autogen/office/office/office.dialog.yml index fbf079b2ab..dd94ed9eb4 100644 --- a/docs/docs-ref-autogen/office/office/office.dialog.yml +++ b/docs/docs-ref-autogen/office/office/office.dialog.yml @@ -169,6 +169,9 @@ methods: - If the `messageOptions` parameter is used, [DialogOrigin 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets) is also required. + + + Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2. isPreview: false isDeprecated: false syntax: diff --git a/docs/docs-ref-autogen/office/office/office.ui.yml b/docs/docs-ref-autogen/office/office/office.ui.yml index 1b067cdd70..6cfc731748 100644 --- a/docs/docs-ref-autogen/office/office/office.ui.yml +++ b/docs/docs-ref-autogen/office/office/office.ui.yml @@ -453,12 +453,18 @@ methods: fullName: 'messageParent(message, messageOptions)' summary: Delivers a message from the dialog box to its parent/opener page. remarks: >- + **Applications**: Excel, Outlook, PowerPoint, Word + + **Requirement sets**: - [DialogAPI](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets) + - [Mailbox 1.4](https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + + - If the `messageOptions` parameter is used, [DialogOrigin 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets) is also required. diff --git a/docs/docs-ref-autogen/office_release/office/office.dialog.yml b/docs/docs-ref-autogen/office_release/office/office.dialog.yml index fbf079b2ab..dd94ed9eb4 100644 --- a/docs/docs-ref-autogen/office_release/office/office.dialog.yml +++ b/docs/docs-ref-autogen/office_release/office/office.dialog.yml @@ -169,6 +169,9 @@ methods: - If the `messageOptions` parameter is used, [DialogOrigin 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets) is also required. + + + Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2. isPreview: false isDeprecated: false syntax: diff --git a/docs/docs-ref-autogen/office_release/office/office.ui.yml b/docs/docs-ref-autogen/office_release/office/office.ui.yml index 1b067cdd70..6cfc731748 100644 --- a/docs/docs-ref-autogen/office_release/office/office.ui.yml +++ b/docs/docs-ref-autogen/office_release/office/office.ui.yml @@ -453,12 +453,18 @@ methods: fullName: 'messageParent(message, messageOptions)' summary: Delivers a message from the dialog box to its parent/opener page. remarks: >- + **Applications**: Excel, Outlook, PowerPoint, Word + + **Requirement sets**: - [DialogAPI](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets) + - [Mailbox 1.4](https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + + - If the `messageOptions` parameter is used, [DialogOrigin 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets) is also required. diff --git a/docs/docs-ref-autogen/outlook/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.sharedproperties.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.sharedproperties.yml index b23fea493b..55f937ff6a 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.sharedproperties.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.sharedproperties.yml @@ -22,6 +22,29 @@ remarks: >- **[Applicable Outlook mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); + + ``` isPreview: false isDeprecated: false type: interface diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 020eda1169..4417c21284 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -8815,7 +8815,7 @@ Office.MailboxEnums.Days,"Sun",EnumField,Poor,false Office.MailboxEnums.Days,"Weekday",EnumField,Fine,false Office.MailboxEnums.Days,"WeekendDay",EnumField,Poor,false Office.MailboxEnums.Days,"Day",EnumField,Poor,false -Office.MailboxEnums.DelegatePermissions,N/A,Enum,Good,false +Office.MailboxEnums.DelegatePermissions,N/A,Enum,Good,true Office.MailboxEnums.DelegatePermissions,"Read",EnumField,Fine,false Office.MailboxEnums.DelegatePermissions,"Write",EnumField,Fine,false Office.MailboxEnums.DelegatePermissions,"DeleteOwn",EnumField,Fine,false @@ -9308,7 +9308,7 @@ Office.SessionData,"removeAsync(name, options, callback)",Method,Poor,true Office.SessionData,"removeAsync(name, callback)",Method,Poor,false Office.SessionData,"setAsync(name, value, options, callback)",Method,Poor,true Office.SessionData,"setAsync(name, value, callback)",Method,Poor,false -Office.SharedProperties,N/A,Class,Good,false +Office.SharedProperties,N/A,Class,Good,true Office.SharedProperties,"delegatePermissions",Property,Fine,false Office.SharedProperties,"owner",Property,Fine,false Office.SharedProperties,"targetMailbox",Property,Good,false diff --git a/generate-docs/api-extractor-inputs-office-release/office.d.ts b/generate-docs/api-extractor-inputs-office-release/office.d.ts index 2edbba8a31..b3c1886e27 100644 --- a/generate-docs/api-extractor-inputs-office-release/office.d.ts +++ b/generate-docs/api-extractor-inputs-office-release/office.d.ts @@ -5468,6 +5468,8 @@ export declare namespace Office { * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. * + * Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2. + * * @param message - Accepts a message from the host page to deliver to the dialog. Anything that can be serialized to a string, including JSON and XML, can be sent. * @param messageOptions - Optional. Provides options for how to send the message. */ @@ -8625,18 +8627,22 @@ export declare namespace Office { */ displayDialogAsync(startAddress: string, callback?: (result: AsyncResult) => void): void; /** - * Delivers a message from the dialog box to its parent/opener page. - * + * Delivers a message from the dialog box to its parent/opener page. + * * @remarks - * - * **Requirement sets**: - * + * + * **Applications**: Excel, Outlook, PowerPoint, Word + * + * **Requirement sets**: + * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi} - * + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4} + * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. - * - * @param message - Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. - * @param messageOptions - Optional. Provides options for how to send the message. + * + * @param message - Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. + * @param messageOptions - Optional. Provides options for how to send the message. */ messageParent(message: string, messageOptions?: DialogMessageOptions): void; /** diff --git a/generate-docs/api-extractor-inputs-office/office.d.ts b/generate-docs/api-extractor-inputs-office/office.d.ts index eee49314bb..93be6314cd 100644 --- a/generate-docs/api-extractor-inputs-office/office.d.ts +++ b/generate-docs/api-extractor-inputs-office/office.d.ts @@ -5520,6 +5520,8 @@ export declare namespace Office { * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. * + * Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2. + * * @param message - Accepts a message from the host page to deliver to the dialog. Anything that can be serialized to a string, including JSON and XML, can be sent. * @param messageOptions - Optional. Provides options for how to send the message. */ @@ -8677,18 +8679,22 @@ export declare namespace Office { */ displayDialogAsync(startAddress: string, callback?: (result: AsyncResult) => void): void; /** - * Delivers a message from the dialog box to its parent/opener page. - * + * Delivers a message from the dialog box to its parent/opener page. + * * @remarks - * - * **Requirement sets**: - * + * + * **Applications**: Excel, Outlook, PowerPoint, Word + * + * **Requirement sets**: + * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi} - * + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4} + * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. - * - * @param message - Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. - * @param messageOptions - Optional. Provides options for how to send the message. + * + * @param message - Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. + * @param messageOptions - Optional. Provides options for how to send the message. */ messageParent(message: string, messageOptions?: DialogMessageOptions): void; /** diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index 1308607a5a..20f0ab91a8 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -5473,6 +5473,8 @@ declare namespace Office { * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. * + * Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2. + * * @param message Accepts a message from the host page to deliver to the dialog. Anything that can be serialized to a string, including JSON and XML, can be sent. * @param messageOptions Optional. Provides options for how to send the message. */ @@ -8630,18 +8632,22 @@ declare namespace Office { */ displayDialogAsync(startAddress: string, callback?: (result: AsyncResult) => void): void; /** - * Delivers a message from the dialog box to its parent/opener page. - * + * Delivers a message from the dialog box to its parent/opener page. + * * @remarks - * - * **Requirement sets**: - * + * + * **Applications**: Excel, Outlook, PowerPoint, Word + * + * **Requirement sets**: + * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi} - * + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4} + * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. - * - * @param message Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. - * @param messageOptions Optional. Provides options for how to send the message. + * + * @param message Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. + * @param messageOptions Optional. Provides options for how to send the message. */ messageParent(message: string, messageOptions?: DialogMessageOptions): void; /** diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 79ce99388f..961582b49c 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -5525,6 +5525,8 @@ declare namespace Office { * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. * + * Although classic Outlook on Mac doesn't support Mailbox 1.9, it does support DialogApi 1.2. + * * @param message Accepts a message from the host page to deliver to the dialog. Anything that can be serialized to a string, including JSON and XML, can be sent. * @param messageOptions Optional. Provides options for how to send the message. */ @@ -8682,18 +8684,22 @@ declare namespace Office { */ displayDialogAsync(startAddress: string, callback?: (result: AsyncResult) => void): void; /** - * Delivers a message from the dialog box to its parent/opener page. - * + * Delivers a message from the dialog box to its parent/opener page. + * * @remarks - * - * **Requirement sets**: - * + * + * **Applications**: Excel, Outlook, PowerPoint, Word + * + * **Requirement sets**: + * * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets | DialogApi} - * + * + * - {@link https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets | Mailbox 1.4} + * * - If the `messageOptions` parameter is used, {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-origin-requirement-sets | DialogOrigin 1.1} is also required. - * - * @param message Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. - * @param messageOptions Optional. Provides options for how to send the message. + * + * @param message Accepts a message from the dialog to deliver to the add-in. Anything that can serialized to a string including JSON and XML can be sent. + * @param messageOptions Optional. Provides options for how to send the message. */ messageParent(message: string, messageOptions?: DialogMessageOptions): void; /** diff --git a/generate-docs/script-inputs/script-lab-snippets.yaml b/generate-docs/script-inputs/script-lab-snippets.yaml index b30fcde654..110a66664a 100644 --- a/generate-docs/script-inputs/script-lab-snippets.yaml +++ b/generate-docs/script-inputs/script-lab-snippets.yaml @@ -13786,6 +13786,22 @@ console.log("Failed to set sessionData. Error: " + JSON.stringify(asyncResult.error)); } }); +'Office.SharedProperties:interface': + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml + + + Office.context.mailbox.item.getSharedPropertiesAsync((result) => { + if (result.status === Office.AsyncResultStatus.Failed) { + console.error("The current folder or mailbox isn't shared."); + return; + } + const sharedProperties = result.value; + console.log(`Owner: ${sharedProperties.owner}`); + console.log(`Permissions: ${sharedProperties.delegatePermissions}`); + console.log(`Target mailbox: ${sharedProperties.targetMailbox}`); + }); 'Office.Time#getAsync:member(2)': - >- // Link to full sample: