diff --git a/docs/code-snippets/officeruntime-snippets.yaml b/docs/code-snippets/officeruntime-snippets.yaml index 619ec8ae7c..b18cc7fc65 100644 --- a/docs/code-snippets/officeruntime-snippets.yaml +++ b/docs/code-snippets/officeruntime-snippets.yaml @@ -68,6 +68,48 @@ OfficeRuntime.Auth#getAccessToken:member(1): } } } +OfficeRuntime.AuthOptions:interface: + - |- + const options: OfficeRuntime.AuthOptions = { + allowSignInPrompt: true, + allowConsentPrompt: true, + forMSGraphAccess: true, + }; + const accessToken = await OfficeRuntime.auth.getAccessToken(options); +OfficeRuntime.Dialog:interface: + - |- + const dialogUrl = "https://your-addin-domain.com/dialog.html"; + const dialogOptions: OfficeRuntime.DisplayWebDialogOptions = { + height: "50%", + width: "50%", + displayInIFrame: false, + onMessage: function (message: string, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog result: " + message); + }, + onRuntimeError: function (error: Error, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog error: " + error.message); + }, + } + OfficeRuntime.displayWebDialog(dialogUrl, dialogOptions); +OfficeRuntime.DisplayWebDialogOptions:interface: + - |- + const dialogUrl = "https://your-addin-domain.com/dialog.html"; + const dialogOptions: OfficeRuntime.DisplayWebDialogOptions = { + height: "50%", + width: "50%", + displayInIFrame: false, + onMessage: function (message: string, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog result: " + message); + }, + onRuntimeError: function (error: Error, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog error: " + error.message); + }, + } + OfficeRuntime.displayWebDialog(dialogUrl, dialogOptions); OfficeRuntime.Storage#getItem:member(1): - |- // Retrieve a value from the shared runtime storage by its key. diff --git a/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.authoptions.yml b/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.authoptions.yml index cdebd14908..1677dcc945 100644 --- a/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.authoptions.yml +++ b/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.authoptions.yml @@ -7,9 +7,21 @@ summary: Provides options for the user experience when Office obtains an access remarks: |- The methods in this interface are equivalent to those in the `Office.AuthOptions` interface. If new authentication types are added in the future, they will only be added to the `Office.AuthOptions` interface. For simplicity, the code examples throughout the documentation use `Office.AuthOptions`. + + #### Used by - [OfficeRuntime.Auth](/javascript/api/office-runtime/officeruntime.auth): [getAccessToken](/javascript/api/office-runtime/officeruntime.auth#office-runtime-officeruntime-auth-getaccesstoken-member(1)) + #### Examples + + ```TypeScript + const options: OfficeRuntime.AuthOptions = { + allowSignInPrompt: true, + allowConsentPrompt: true, + forMSGraphAccess: true, + }; + const accessToken = await OfficeRuntime.auth.getAccessToken(options); + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.dialog.yml b/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.dialog.yml index 0e1ed6bc10..357e81c9ab 100644 --- a/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.dialog.yml +++ b/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.dialog.yml @@ -7,10 +7,31 @@ summary: Object representing the dialog box. remarks: |- [API set: CustomFunctionsRuntime 1.1](/office/dev/add-ins/reference/javascript-api-for-office) + + #### Used by - [OfficeRuntime](/javascript/api/office-runtime): [displayWebDialog](/javascript/api/office-runtime#office-runtime-officeruntime-displaywebdialog-function(1)) - [OfficeRuntime.DisplayWebDialogOptions](/javascript/api/office-runtime/officeruntime.displaywebdialogoptions): [onMessage](/javascript/api/office-runtime/officeruntime.displaywebdialogoptions#office-runtime-officeruntime-displaywebdialogoptions-onmessage-member), [onRuntimeError](/javascript/api/office-runtime/officeruntime.displaywebdialogoptions#office-runtime-officeruntime-displaywebdialogoptions-onruntimeerror-member) + #### Examples + + ```TypeScript + const dialogUrl = "https://your-addin-domain.com/dialog.html"; + const dialogOptions: OfficeRuntime.DisplayWebDialogOptions = { + height: "50%", + width: "50%", + displayInIFrame: false, + onMessage: function (message: string, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog result: " + message); + }, + onRuntimeError: function (error: Error, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog error: " + error.message); + }, + } + OfficeRuntime.displayWebDialog(dialogUrl, dialogOptions); + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.displaywebdialogoptions.yml b/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.displaywebdialogoptions.yml index 7db787993a..8c735325f5 100644 --- a/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.displaywebdialogoptions.yml +++ b/docs/docs-ref-autogen/office-runtime/office-runtime/officeruntime.displaywebdialogoptions.yml @@ -7,9 +7,30 @@ summary: Provides display options and actions a dialog box may take. remarks: |- [API set: CustomFunctionsRuntime 1.1](/office/dev/add-ins/reference/javascript-api-for-office) + + #### Used by - [OfficeRuntime](/javascript/api/office-runtime): [displayWebDialog](/javascript/api/office-runtime#office-runtime-officeruntime-displaywebdialog-function(1)) + #### Examples + + ```TypeScript + const dialogUrl = "https://your-addin-domain.com/dialog.html"; + const dialogOptions: OfficeRuntime.DisplayWebDialogOptions = { + height: "50%", + width: "50%", + displayInIFrame: false, + onMessage: function (message: string, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog result: " + message); + }, + onRuntimeError: function (error: Error, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog error: " + error.message); + }, + } + OfficeRuntime.displayWebDialog(dialogUrl, dialogOptions); + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/office/office/office.asynccontextoptions.yml b/docs/docs-ref-autogen/office/office/office.asynccontextoptions.yml index d6d4fc116c..48f78e6c2d 100644 --- a/docs/docs-ref-autogen/office/office/office.asynccontextoptions.yml +++ b/docs/docs-ref-autogen/office/office/office.asynccontextoptions.yml @@ -7,6 +7,7 @@ summary: Provides an option for preserving context data of any type, unchanged, remarks: |- + #### Used by - [Office.AppointmentCompose](/javascript/api/outlook/office.appointmentcompose): [addFileAttachmentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentasync-member(1)), [addFileAttachmentFromBase64Async](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentfrombase64async-member(1)), [addHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1)), [addItemAttachmentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-additemattachmentasync-member(1)), [disableClientSignatureAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-disableclientsignatureasync-member(1)), [getAttachmentContentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentcontentasync-member(1)), [getAttachmentsAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentsasync-member(1)), [getInitializationContextAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getinitializationcontextasync-member(1)), [getItemIdAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getitemidasync-member(1)), [getSelectedDataAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1)), [getSharedPropertiesAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getsharedpropertiesasync-member(1)), [isClientSignatureEnabledAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isclientsignatureenabledasync-member(1)), [removeAttachmentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1)), [removeHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1)), [saveAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-saveasync-member(1)), [sendAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sendasync-member(1)), [setSelectedDataAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-setselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.asyncresult.yml b/docs/docs-ref-autogen/office/office/office.asyncresult.yml index 671efd712b..35e4a881d5 100644 --- a/docs/docs-ref-autogen/office/office/office.asyncresult.yml +++ b/docs/docs-ref-autogen/office/office/office.asyncresult.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office](/javascript/api/office): [select](/javascript/api/office#office-office-select-function(1)) diff --git a/docs/docs-ref-autogen/office/office/office.asyncresultstatus.yml b/docs/docs-ref-autogen/office/office/office.asyncresultstatus.yml index b332d5d536..8b499e58f6 100644 --- a/docs/docs-ref-autogen/office/office/office.asyncresultstatus.yml +++ b/docs/docs-ref-autogen/office/office/office.asyncresultstatus.yml @@ -8,7 +8,6 @@ remarks: |- Returned by the `status` property of the [AsyncResult](xref:office!Office.AsyncResult:interface) object. - #### Used by - [Office.AsyncResult](/javascript/api/office/office.asyncresult): [status](/javascript/api/office/office.asyncresult#office-office-asyncresult-status-member) diff --git a/docs/docs-ref-autogen/office/office/office.beforedocumentclosenotification.yml b/docs/docs-ref-autogen/office/office/office.beforedocumentclosenotification.yml index 08cde83245..89e69e722f 100644 --- a/docs/docs-ref-autogen/office/office/office.beforedocumentclosenotification.yml +++ b/docs/docs-ref-autogen/office/office/office.beforedocumentclosenotification.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [SharedRuntime 1.2](https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets) - #### Used by - [Office.Addin](/javascript/api/office/office.addin): [beforeDocumentCloseNotification](/javascript/api/office/office.addin#office-office-addin-beforedocumentclosenotification-member) diff --git a/docs/docs-ref-autogen/office/office/office.bindingdatachangedeventargs.yml b/docs/docs-ref-autogen/office/office/office.bindingdatachangedeventargs.yml index daeae21614..08b7e681b0 100644 --- a/docs/docs-ref-autogen/office/office/office.bindingdatachangedeventargs.yml +++ b/docs/docs-ref-autogen/office/office/office.bindingdatachangedeventargs.yml @@ -7,6 +7,7 @@ summary: Provides information about the binding that raised the DataChanged even remarks: |- + #### Used by - [Office.RemoveHandlerOptions](/javascript/api/office/office.removehandleroptions): [handler](/javascript/api/office/office.removehandleroptions#office-office-removehandleroptions-handler-member) diff --git a/docs/docs-ref-autogen/office/office/office.bindingtype.yml b/docs/docs-ref-autogen/office/office/office.bindingtype.yml index cdc14a56d2..38916a5eab 100644 --- a/docs/docs-ref-autogen/office/office/office.bindingtype.yml +++ b/docs/docs-ref-autogen/office/office/office.bindingtype.yml @@ -7,6 +7,7 @@ summary: Specifies the type of the binding object that should be returned. remarks: |- + #### Used by - [Office.Binding](/javascript/api/office/office.binding): [type](/javascript/api/office/office.binding#office-office-binding-type-member) diff --git a/docs/docs-ref-autogen/office/office/office.coerciontype.yml b/docs/docs-ref-autogen/office/office/office.coerciontype.yml index ab9fc29c54..648e213932 100644 --- a/docs/docs-ref-autogen/office/office/office.coerciontype.yml +++ b/docs/docs-ref-autogen/office/office/office.coerciontype.yml @@ -24,7 +24,6 @@ remarks: |- - [ImageCoercion 1.2](https://learn.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12) (when using `Office.CoercionType.XmlSvg`) - #### Used by - [Office.AppointmentCompose](/javascript/api/outlook/office.appointmentcompose): [getSelectedDataAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.contextmenucontrol.yml b/docs/docs-ref-autogen/office/office/office.contextmenucontrol.yml index a73926e8d7..1687e0b49d 100644 --- a/docs/docs-ref-autogen/office/office/office.contextmenucontrol.yml +++ b/docs/docs-ref-autogen/office/office/office.contextmenucontrol.yml @@ -11,7 +11,6 @@ remarks: |- **Requirement set**: [ContextMenuApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets) - #### Used by - [Office.ContextMenuUpdaterData](/javascript/api/office/office.contextmenuupdaterdata): [controls](/javascript/api/office/office.contextmenuupdaterdata#office-office-contextmenuupdaterdata-controls-member) diff --git a/docs/docs-ref-autogen/office/office/office.control.yml b/docs/docs-ref-autogen/office/office/office.control.yml index ed8621edf3..9db6db0c46 100644 --- a/docs/docs-ref-autogen/office/office/office.control.yml +++ b/docs/docs-ref-autogen/office/office/office.control.yml @@ -10,7 +10,6 @@ remarks: |- **Requirement set**: [RibbonApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets) - #### Used by - [Office.Group](/javascript/api/office/office.group): [controls](/javascript/api/office/office.group#office-office-group-controls-member) diff --git a/docs/docs-ref-autogen/office/office/office.devicepermissiontype.yml b/docs/docs-ref-autogen/office/office/office.devicepermissiontype.yml index c78b15d3d7..4d99f9780c 100644 --- a/docs/docs-ref-autogen/office/office/office.devicepermissiontype.yml +++ b/docs/docs-ref-autogen/office/office/office.devicepermissiontype.yml @@ -20,7 +20,6 @@ remarks: |- **Requirement set**: [DevicePermission 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/device-permission-service-requirement-sets) - #### Used by - [Office.DevicePermission](/javascript/api/office/office.devicepermission): [requestPermissions](/javascript/api/office/office.devicepermission#office-office-devicepermission-requestpermissions-member(1)), [requestPermissionsAsync](/javascript/api/office/office.devicepermission#office-office-devicepermission-requestpermissionsasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.dialog.yml b/docs/docs-ref-autogen/office/office/office.dialog.yml index d29dd4cec5..f8b2946821 100644 --- a/docs/docs-ref-autogen/office/office/office.dialog.yml +++ b/docs/docs-ref-autogen/office/office/office.dialog.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [DialogApi](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets) - #### Used by - [Office.UI](/javascript/api/office/office.ui): [displayDialogAsync](/javascript/api/office/office.ui#office-office-ui-displaydialogasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.dialogparentmessagereceivedeventargs.yml b/docs/docs-ref-autogen/office/office/office.dialogparentmessagereceivedeventargs.yml index ead75770e3..74f9edb331 100644 --- a/docs/docs-ref-autogen/office/office/office.dialogparentmessagereceivedeventargs.yml +++ b/docs/docs-ref-autogen/office/office/office.dialogparentmessagereceivedeventargs.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.UI](/javascript/api/office/office.ui): [addHandlerAsync](/javascript/api/office/office.ui#office-office-ui-addhandlerasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.document.yml b/docs/docs-ref-autogen/office/office/office.document.yml index 54d94c59c3..f7e63163e4 100644 --- a/docs/docs-ref-autogen/office/office/office.document.yml +++ b/docs/docs-ref-autogen/office/office/office.document.yml @@ -8,7 +8,6 @@ remarks: |- **Applications**: Excel, PowerPoint, Project, Word - #### Used by - [Office.Binding](/javascript/api/office/office.binding): [document](/javascript/api/office/office.binding#office-office-binding-document-member) diff --git a/docs/docs-ref-autogen/office/office/office.documentmode.yml b/docs/docs-ref-autogen/office/office/office.documentmode.yml index 18417b3101..4d524e227c 100644 --- a/docs/docs-ref-autogen/office/office/office.documentmode.yml +++ b/docs/docs-ref-autogen/office/office/office.documentmode.yml @@ -8,7 +8,6 @@ remarks: |- Returned by the mode property of the [Document](xref:office!Office.Document:interface) object. - #### Used by - [Office.Document](/javascript/api/office/office.document): [mode](/javascript/api/office/office.document#office-office-document-mode-member) diff --git a/docs/docs-ref-autogen/office/office/office.eventtype.yml b/docs/docs-ref-autogen/office/office/office.eventtype.yml index 6271e1bb13..6537ba08eb 100644 --- a/docs/docs-ref-autogen/office/office/office.eventtype.yml +++ b/docs/docs-ref-autogen/office/office/office.eventtype.yml @@ -12,6 +12,7 @@ summary: |- remarks: |- + #### Used by - [Office.AppointmentCompose](/javascript/api/outlook/office.appointmentcompose): [addHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1)), [removeHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.file.yml b/docs/docs-ref-autogen/office/office/office.file.yml index 5b52259d88..a486005b32 100644 --- a/docs/docs-ref-autogen/office/office/office.file.yml +++ b/docs/docs-ref-autogen/office/office/office.file.yml @@ -8,7 +8,6 @@ remarks: |- Access the File object with the AsyncResult.value property in the callback function passed to the Document.getFileAsync method. - #### Used by - [Office.Document](/javascript/api/office/office.document): [getFileAsync](/javascript/api/office/office.document#office-office-document-getfileasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.fileproperties.yml b/docs/docs-ref-autogen/office/office/office.fileproperties.yml index 469c5c9902..80e6e1aafd 100644 --- a/docs/docs-ref-autogen/office/office/office.fileproperties.yml +++ b/docs/docs-ref-autogen/office/office/office.fileproperties.yml @@ -7,6 +7,7 @@ summary: '' remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getFilePropertiesAsync](/javascript/api/office/office.document#office-office-document-getfilepropertiesasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.filetype.yml b/docs/docs-ref-autogen/office/office/office.filetype.yml index 221ccda36c..8905a0d49b 100644 --- a/docs/docs-ref-autogen/office/office/office.filetype.yml +++ b/docs/docs-ref-autogen/office/office/office.filetype.yml @@ -7,6 +7,7 @@ summary: Specifies the format in which to return the document. remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getFileAsync](/javascript/api/office/office.document#office-office-document-getfileasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.filtertype.yml b/docs/docs-ref-autogen/office/office/office.filtertype.yml index 241071f4ec..167cc61daa 100644 --- a/docs/docs-ref-autogen/office/office/office.filtertype.yml +++ b/docs/docs-ref-autogen/office/office/office.filtertype.yml @@ -7,6 +7,7 @@ summary: Specifies whether filtering from the Office application is applied when remarks: |- + #### Used by - [Office.GetBindingDataOptions](/javascript/api/office/office.getbindingdataoptions): [filterType](/javascript/api/office/office.getbindingdataoptions#office-office-getbindingdataoptions-filtertype-member) diff --git a/docs/docs-ref-autogen/office/office/office.getselecteddataoptions.yml b/docs/docs-ref-autogen/office/office/office.getselecteddataoptions.yml index 46896f1f30..826cc85b90 100644 --- a/docs/docs-ref-autogen/office/office/office.getselecteddataoptions.yml +++ b/docs/docs-ref-autogen/office/office/office.getselecteddataoptions.yml @@ -7,6 +7,7 @@ summary: Provides options for customizing what data is returned and how it is fo remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getSelectedDataAsync](/javascript/api/office/office.document#office-office-document-getselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.gototype.yml b/docs/docs-ref-autogen/office/office/office.gototype.yml index 30fb1022e3..8e013fbd1d 100644 --- a/docs/docs-ref-autogen/office/office/office.gototype.yml +++ b/docs/docs-ref-autogen/office/office/office.gototype.yml @@ -7,6 +7,7 @@ summary: Specifies the type of place or object to navigate to. remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [goToByIdAsync](/javascript/api/office/office.document#office-office-document-gotobyidasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.group.yml b/docs/docs-ref-autogen/office/office/office.group.yml index c98977c894..5b04861017 100644 --- a/docs/docs-ref-autogen/office/office/office.group.yml +++ b/docs/docs-ref-autogen/office/office/office.group.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.Tab](/javascript/api/office/office.tab): [groups](/javascript/api/office/office.tab#office-office-tab-groups-member) diff --git a/docs/docs-ref-autogen/office/office/office.hosttype.yml b/docs/docs-ref-autogen/office/office/office.hosttype.yml index 6a64966ba2..c99fa196e1 100644 --- a/docs/docs-ref-autogen/office/office/office.hosttype.yml +++ b/docs/docs-ref-autogen/office/office/office.hosttype.yml @@ -8,7 +8,6 @@ remarks: |- **Important**: In Outlook, this enum is available starting with Mailbox requirement set 1.5. - #### Used by - [Office](/javascript/api/office): [onReady](/javascript/api/office#office-office-onready-function(1)) diff --git a/docs/docs-ref-autogen/office/office/office.initializationreason.yml b/docs/docs-ref-autogen/office/office/office.initializationreason.yml index d3e22663ed..5800b8f58c 100644 --- a/docs/docs-ref-autogen/office/office/office.initializationreason.yml +++ b/docs/docs-ref-autogen/office/office/office.initializationreason.yml @@ -7,6 +7,7 @@ summary: Specifies whether the add-in was just inserted or was already contained remarks: |- + #### Used by - [Office](/javascript/api/office): [initialize](/javascript/api/office#office-office-initialize-function(1)) diff --git a/docs/docs-ref-autogen/office/office/office.officetheme.yml b/docs/docs-ref-autogen/office/office/office.officetheme.yml index df809432e0..54e544f596 100644 --- a/docs/docs-ref-autogen/office/office/office.officetheme.yml +++ b/docs/docs-ref-autogen/office/office/office.officetheme.yml @@ -15,7 +15,6 @@ remarks: |- **Important**: In Outlook, the Office theme API is supported starting in [Mailbox requirement set 1.14](https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-14). It isn't supported in Outlook add-ins that implement [event-based activation](https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation). - #### Used by - [Office.Context](/javascript/api/office/office.context): [officeTheme](/javascript/api/office/office.context#office-office-context-officetheme-member) diff --git a/docs/docs-ref-autogen/office/office/office.platformtype.yml b/docs/docs-ref-autogen/office/office/office.platformtype.yml index 600578bb99..70753b1314 100644 --- a/docs/docs-ref-autogen/office/office/office.platformtype.yml +++ b/docs/docs-ref-autogen/office/office/office.platformtype.yml @@ -8,7 +8,6 @@ remarks: |- **Important**: In Outlook, this enum is available starting with Mailbox requirement set 1.5. - #### Used by - [Office](/javascript/api/office): [onReady](/javascript/api/office#office-office-onready-function(1)) diff --git a/docs/docs-ref-autogen/office/office/office.rangecoordinates.yml b/docs/docs-ref-autogen/office/office/office.rangecoordinates.yml index d34527ce43..bbe5920481 100644 --- a/docs/docs-ref-autogen/office/office/office.rangecoordinates.yml +++ b/docs/docs-ref-autogen/office/office/office.rangecoordinates.yml @@ -7,6 +7,7 @@ summary: 'Specifies a cell, or row, or column, by its zero-based row and/or colu remarks: |- + #### Used by - [Office.RangeFormatConfiguration](/javascript/api/office/office.rangeformatconfiguration): [cells](/javascript/api/office/office.rangeformatconfiguration#office-office-rangeformatconfiguration-cells-member) diff --git a/docs/docs-ref-autogen/office/office/office.rangeformatconfiguration.yml b/docs/docs-ref-autogen/office/office/office.rangeformatconfiguration.yml index 89a7e7e655..56dcad4b2f 100644 --- a/docs/docs-ref-autogen/office/office/office.rangeformatconfiguration.yml +++ b/docs/docs-ref-autogen/office/office/office.rangeformatconfiguration.yml @@ -7,6 +7,7 @@ summary: Specifies a range and its formatting. remarks: |- + #### Used by - [Office.SetBindingDataOptions](/javascript/api/office/office.setbindingdataoptions): [cellFormat](/javascript/api/office/office.setbindingdataoptions#office-office-setbindingdataoptions-cellformat-member) diff --git a/docs/docs-ref-autogen/office/office/office.requirementsetsupport.yml b/docs/docs-ref-autogen/office/office/office.requirementsetsupport.yml index 975b1b7bbc..88f8de208e 100644 --- a/docs/docs-ref-autogen/office/office/office.requirementsetsupport.yml +++ b/docs/docs-ref-autogen/office/office/office.requirementsetsupport.yml @@ -7,6 +7,7 @@ summary: Provides information about which Requirement Sets are supported in the remarks: |- + #### Used by - [Office.Context](/javascript/api/office/office.context): [requirements](/javascript/api/office/office.context#office-office-context-requirements-member) diff --git a/docs/docs-ref-autogen/office/office/office.savesettingsoptions.yml b/docs/docs-ref-autogen/office/office/office.savesettingsoptions.yml index 05c929c57a..cfb6bd57fd 100644 --- a/docs/docs-ref-autogen/office/office/office.savesettingsoptions.yml +++ b/docs/docs-ref-autogen/office/office/office.savesettingsoptions.yml @@ -7,6 +7,7 @@ summary: Provides options for saving settings. remarks: |- + #### Used by - [Office.Settings](/javascript/api/office/office.settings): [saveAsync](/javascript/api/office/office.settings#office-office-settings-saveasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.setselecteddataoptions.yml b/docs/docs-ref-autogen/office/office/office.setselecteddataoptions.yml index 09af13c34e..122eade654 100644 --- a/docs/docs-ref-autogen/office/office/office.setselecteddataoptions.yml +++ b/docs/docs-ref-autogen/office/office/office.setselecteddataoptions.yml @@ -7,6 +7,7 @@ summary: Provides options for how to insert data to the selection. remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [setSelectedDataAsync](/javascript/api/office/office.document#office-office-document-setselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.slice.yml b/docs/docs-ref-autogen/office/office/office.slice.yml index 26b842671f..5846664057 100644 --- a/docs/docs-ref-autogen/office/office/office.slice.yml +++ b/docs/docs-ref-autogen/office/office/office.slice.yml @@ -7,6 +7,7 @@ summary: Represents a slice of a document file. The Slice object is accessed wit remarks: |- + #### Used by - [Office.File](/javascript/api/office/office.file): [getSliceAsync](/javascript/api/office/office.file#office-office-file-getsliceasync-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.sliderange.yml b/docs/docs-ref-autogen/office/office/office.sliderange.yml index fd682421e7..f3fcc4a342 100644 --- a/docs/docs-ref-autogen/office/office/office.sliderange.yml +++ b/docs/docs-ref-autogen/office/office/office.sliderange.yml @@ -7,6 +7,7 @@ summary: Represents the selected slides in a PowerPoint presentation. This objec remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getSelectedDataAsync](/javascript/api/office/office.document#office-office-document-getselecteddataasync-member(4)) diff --git a/docs/docs-ref-autogen/office/office/office.startupbehavior.yml b/docs/docs-ref-autogen/office/office/office.startupbehavior.yml index 30fa550ad0..23772ab49c 100644 --- a/docs/docs-ref-autogen/office/office/office.startupbehavior.yml +++ b/docs/docs-ref-autogen/office/office/office.startupbehavior.yml @@ -7,6 +7,7 @@ summary: Provides options to determine the startup behavior of the add-in upon n remarks: |- + #### Used by - [Office.Addin](/javascript/api/office/office.addin): [getStartupBehavior](/javascript/api/office/office.addin#office-office-addin-getstartupbehavior-member(1)), [setStartupBehavior](/javascript/api/office/office.addin#office-office-addin-setstartupbehavior-member(1)) diff --git a/docs/docs-ref-autogen/office/office/office.tab.yml b/docs/docs-ref-autogen/office/office/office.tab.yml index 4c2a7ba006..855d21c925 100644 --- a/docs/docs-ref-autogen/office/office/office.tab.yml +++ b/docs/docs-ref-autogen/office/office/office.tab.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [RibbonApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets) - #### Used by - [Office.RibbonUpdaterData](/javascript/api/office/office.ribbonupdaterdata): [tabs](/javascript/api/office/office.ribbonupdaterdata#office-office-ribbonupdaterdata-tabs-member) diff --git a/docs/docs-ref-autogen/office/office/office.taskpane.yml b/docs/docs-ref-autogen/office/office/office.taskpane.yml index e65e942154..a4f52a0792 100644 --- a/docs/docs-ref-autogen/office/office/office.taskpane.yml +++ b/docs/docs-ref-autogen/office/office/office.taskpane.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [TaskPaneApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/task-pane-api-requirement-sets) - #### Used by - [Office.ExtensionLifeCycle](/javascript/api/office/office.extensionlifecycle): [taskpane](/javascript/api/office/office.extensionlifecycle#office-office-extensionlifecycle-taskpane-member) diff --git a/docs/docs-ref-autogen/office/office/office.themeid.yml b/docs/docs-ref-autogen/office/office/office.themeid.yml index 4d00b354bb..334f7f6f6b 100644 --- a/docs/docs-ref-autogen/office/office/office.themeid.yml +++ b/docs/docs-ref-autogen/office/office/office.themeid.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.OfficeTheme](/javascript/api/office/office.officetheme): [themeId](/javascript/api/office/office.officetheme#office-office-officetheme-themeid-member) diff --git a/docs/docs-ref-autogen/office/office/office.ui.yml b/docs/docs-ref-autogen/office/office/office.ui.yml index c48713108d..4a8f6382e9 100644 --- a/docs/docs-ref-autogen/office/office/office.ui.yml +++ b/docs/docs-ref-autogen/office/office/office.ui.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.Context](/javascript/api/office/office.context): [ui](/javascript/api/office/office.context#office-office-context-ui-member) diff --git a/docs/docs-ref-autogen/office/office/office.valueformat.yml b/docs/docs-ref-autogen/office/office/office.valueformat.yml index c3d5b02381..e88a29391d 100644 --- a/docs/docs-ref-autogen/office/office/office.valueformat.yml +++ b/docs/docs-ref-autogen/office/office/office.valueformat.yml @@ -8,7 +8,6 @@ remarks: |- For example, if the valueFormat parameter is specified as "formatted", a number formatted as currency, or a date formatted as mm/dd/yy in the Office application will have its formatting preserved. If the valueFormat parameter is specified as "unformatted", a date will be returned in its underlying sequential serial number form. - #### Used by - [Office.GetBindingDataOptions](/javascript/api/office/office.getbindingdataoptions): [valueFormat](/javascript/api/office/office.getbindingdataoptions#office-office-getbindingdataoptions-valueformat-member) diff --git a/docs/docs-ref-autogen/office/office/office.visibilitymode.yml b/docs/docs-ref-autogen/office/office/office.visibilitymode.yml index b2fedeca63..2da25446f3 100644 --- a/docs/docs-ref-autogen/office/office/office.visibilitymode.yml +++ b/docs/docs-ref-autogen/office/office/office.visibilitymode.yml @@ -7,6 +7,7 @@ summary: Visibility mode of the add-in. remarks: |- + #### Used by - [Office.VisibilityModeChangedMessage](/javascript/api/office/office.visibilitymodechangedmessage): [visibilityMode](/javascript/api/office/office.visibilitymodechangedmessage#office-office-visibilitymodechangedmessage-visibilitymode-member) diff --git a/docs/docs-ref-autogen/office/office/office.visibilitymodechangedmessage.yml b/docs/docs-ref-autogen/office/office/office.visibilitymodechangedmessage.yml index 81b53af6d8..d7b24c800e 100644 --- a/docs/docs-ref-autogen/office/office/office.visibilitymodechangedmessage.yml +++ b/docs/docs-ref-autogen/office/office/office.visibilitymodechangedmessage.yml @@ -7,6 +7,7 @@ summary: Message used in the `onVisibilityModeChanged` invocation. remarks: |- + #### Used by - [Office.Addin](/javascript/api/office/office.addin): [onVisibilityModeChanged](/javascript/api/office/office.addin#office-office-addin-onvisibilitymodechanged-member(1)) diff --git a/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml b/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml index ee8d8dd1e5..5815d050e1 100644 --- a/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml +++ b/docs/docs-ref-autogen/office/office/officeextension.clientresult.yml @@ -7,6 +7,7 @@ summary: Contains the result for methods that return primitive types. The object remarks: |- + #### Used by - [Excel.AllowEditRangeCollection](/javascript/api/excel/excel.alloweditrangecollection): [getCount](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getcount-member(1)) diff --git a/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml b/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml index e69dd6896b..27f21843b0 100644 --- a/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml +++ b/docs/docs-ref-autogen/office/office/officeextension.loadoption.yml @@ -20,7 +20,6 @@ remarks: |- Note that if we don't specify the specific properties on the font object in the select statement, the expand statement by itself would indicate that all of the font properties are loaded. - #### Used by - [Excel.AllowEditRangeCollection](/javascript/api/excel/excel.alloweditrangecollection): [load](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-load-member(3)) diff --git a/docs/docs-ref-autogen/office/office/officeextension.updateoptions.yml b/docs/docs-ref-autogen/office/office/officeextension.updateoptions.yml index e90ad0da7f..1fc3288d80 100644 --- a/docs/docs-ref-autogen/office/office/officeextension.updateoptions.yml +++ b/docs/docs-ref-autogen/office/office/officeextension.updateoptions.yml @@ -7,6 +7,7 @@ summary: Provides an option for suppressing an error when the object that is use remarks: |- + #### Used by - [Excel.AllowEditRange](/javascript/api/excel/excel.alloweditrange): [set](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-set-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.asynccontextoptions.yml b/docs/docs-ref-autogen/office_release/office/office.asynccontextoptions.yml index d6d4fc116c..48f78e6c2d 100644 --- a/docs/docs-ref-autogen/office_release/office/office.asynccontextoptions.yml +++ b/docs/docs-ref-autogen/office_release/office/office.asynccontextoptions.yml @@ -7,6 +7,7 @@ summary: Provides an option for preserving context data of any type, unchanged, remarks: |- + #### Used by - [Office.AppointmentCompose](/javascript/api/outlook/office.appointmentcompose): [addFileAttachmentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentasync-member(1)), [addFileAttachmentFromBase64Async](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentfrombase64async-member(1)), [addHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1)), [addItemAttachmentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-additemattachmentasync-member(1)), [disableClientSignatureAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-disableclientsignatureasync-member(1)), [getAttachmentContentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentcontentasync-member(1)), [getAttachmentsAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentsasync-member(1)), [getInitializationContextAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getinitializationcontextasync-member(1)), [getItemIdAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getitemidasync-member(1)), [getSelectedDataAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1)), [getSharedPropertiesAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getsharedpropertiesasync-member(1)), [isClientSignatureEnabledAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isclientsignatureenabledasync-member(1)), [removeAttachmentAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1)), [removeHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1)), [saveAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-saveasync-member(1)), [sendAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sendasync-member(1)), [setSelectedDataAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-setselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.asyncresult.yml b/docs/docs-ref-autogen/office_release/office/office.asyncresult.yml index 671efd712b..35e4a881d5 100644 --- a/docs/docs-ref-autogen/office_release/office/office.asyncresult.yml +++ b/docs/docs-ref-autogen/office_release/office/office.asyncresult.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office](/javascript/api/office): [select](/javascript/api/office#office-office-select-function(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.asyncresultstatus.yml b/docs/docs-ref-autogen/office_release/office/office.asyncresultstatus.yml index b332d5d536..8b499e58f6 100644 --- a/docs/docs-ref-autogen/office_release/office/office.asyncresultstatus.yml +++ b/docs/docs-ref-autogen/office_release/office/office.asyncresultstatus.yml @@ -8,7 +8,6 @@ remarks: |- Returned by the `status` property of the [AsyncResult](xref:office!Office.AsyncResult:interface) object. - #### Used by - [Office.AsyncResult](/javascript/api/office/office.asyncresult): [status](/javascript/api/office/office.asyncresult#office-office-asyncresult-status-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.beforedocumentclosenotification.yml b/docs/docs-ref-autogen/office_release/office/office.beforedocumentclosenotification.yml index 08cde83245..89e69e722f 100644 --- a/docs/docs-ref-autogen/office_release/office/office.beforedocumentclosenotification.yml +++ b/docs/docs-ref-autogen/office_release/office/office.beforedocumentclosenotification.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [SharedRuntime 1.2](https://learn.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets) - #### Used by - [Office.Addin](/javascript/api/office/office.addin): [beforeDocumentCloseNotification](/javascript/api/office/office.addin#office-office-addin-beforedocumentclosenotification-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.bindingdatachangedeventargs.yml b/docs/docs-ref-autogen/office_release/office/office.bindingdatachangedeventargs.yml index daeae21614..08b7e681b0 100644 --- a/docs/docs-ref-autogen/office_release/office/office.bindingdatachangedeventargs.yml +++ b/docs/docs-ref-autogen/office_release/office/office.bindingdatachangedeventargs.yml @@ -7,6 +7,7 @@ summary: Provides information about the binding that raised the DataChanged even remarks: |- + #### Used by - [Office.RemoveHandlerOptions](/javascript/api/office/office.removehandleroptions): [handler](/javascript/api/office/office.removehandleroptions#office-office-removehandleroptions-handler-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.bindingtype.yml b/docs/docs-ref-autogen/office_release/office/office.bindingtype.yml index cdc14a56d2..38916a5eab 100644 --- a/docs/docs-ref-autogen/office_release/office/office.bindingtype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.bindingtype.yml @@ -7,6 +7,7 @@ summary: Specifies the type of the binding object that should be returned. remarks: |- + #### Used by - [Office.Binding](/javascript/api/office/office.binding): [type](/javascript/api/office/office.binding#office-office-binding-type-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.coerciontype.yml b/docs/docs-ref-autogen/office_release/office/office.coerciontype.yml index ab9fc29c54..648e213932 100644 --- a/docs/docs-ref-autogen/office_release/office/office.coerciontype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.coerciontype.yml @@ -24,7 +24,6 @@ remarks: |- - [ImageCoercion 1.2](https://learn.microsoft.com/javascript/api/requirement-sets/common/image-coercion-requirement-sets#imagecoercion-12) (when using `Office.CoercionType.XmlSvg`) - #### Used by - [Office.AppointmentCompose](/javascript/api/outlook/office.appointmentcompose): [getSelectedDataAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.contextmenucontrol.yml b/docs/docs-ref-autogen/office_release/office/office.contextmenucontrol.yml index a73926e8d7..1687e0b49d 100644 --- a/docs/docs-ref-autogen/office_release/office/office.contextmenucontrol.yml +++ b/docs/docs-ref-autogen/office_release/office/office.contextmenucontrol.yml @@ -11,7 +11,6 @@ remarks: |- **Requirement set**: [ContextMenuApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets) - #### Used by - [Office.ContextMenuUpdaterData](/javascript/api/office/office.contextmenuupdaterdata): [controls](/javascript/api/office/office.contextmenuupdaterdata#office-office-contextmenuupdaterdata-controls-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.control.yml b/docs/docs-ref-autogen/office_release/office/office.control.yml index ed8621edf3..9db6db0c46 100644 --- a/docs/docs-ref-autogen/office_release/office/office.control.yml +++ b/docs/docs-ref-autogen/office_release/office/office.control.yml @@ -10,7 +10,6 @@ remarks: |- **Requirement set**: [RibbonApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets) - #### Used by - [Office.Group](/javascript/api/office/office.group): [controls](/javascript/api/office/office.group#office-office-group-controls-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.devicepermissiontype.yml b/docs/docs-ref-autogen/office_release/office/office.devicepermissiontype.yml index c78b15d3d7..4d99f9780c 100644 --- a/docs/docs-ref-autogen/office_release/office/office.devicepermissiontype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.devicepermissiontype.yml @@ -20,7 +20,6 @@ remarks: |- **Requirement set**: [DevicePermission 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/device-permission-service-requirement-sets) - #### Used by - [Office.DevicePermission](/javascript/api/office/office.devicepermission): [requestPermissions](/javascript/api/office/office.devicepermission#office-office-devicepermission-requestpermissions-member(1)), [requestPermissionsAsync](/javascript/api/office/office.devicepermission#office-office-devicepermission-requestpermissionsasync-member(1)) 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 d29dd4cec5..f8b2946821 100644 --- a/docs/docs-ref-autogen/office_release/office/office.dialog.yml +++ b/docs/docs-ref-autogen/office_release/office/office.dialog.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [DialogApi](https://learn.microsoft.com/javascript/api/requirement-sets/common/dialog-api-requirement-sets) - #### Used by - [Office.UI](/javascript/api/office/office.ui): [displayDialogAsync](/javascript/api/office/office.ui#office-office-ui-displaydialogasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.dialogparentmessagereceivedeventargs.yml b/docs/docs-ref-autogen/office_release/office/office.dialogparentmessagereceivedeventargs.yml index ead75770e3..74f9edb331 100644 --- a/docs/docs-ref-autogen/office_release/office/office.dialogparentmessagereceivedeventargs.yml +++ b/docs/docs-ref-autogen/office_release/office/office.dialogparentmessagereceivedeventargs.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.UI](/javascript/api/office/office.ui): [addHandlerAsync](/javascript/api/office/office.ui#office-office-ui-addhandlerasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.document.yml b/docs/docs-ref-autogen/office_release/office/office.document.yml index 54d94c59c3..f7e63163e4 100644 --- a/docs/docs-ref-autogen/office_release/office/office.document.yml +++ b/docs/docs-ref-autogen/office_release/office/office.document.yml @@ -8,7 +8,6 @@ remarks: |- **Applications**: Excel, PowerPoint, Project, Word - #### Used by - [Office.Binding](/javascript/api/office/office.binding): [document](/javascript/api/office/office.binding#office-office-binding-document-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.documentmode.yml b/docs/docs-ref-autogen/office_release/office/office.documentmode.yml index 18417b3101..4d524e227c 100644 --- a/docs/docs-ref-autogen/office_release/office/office.documentmode.yml +++ b/docs/docs-ref-autogen/office_release/office/office.documentmode.yml @@ -8,7 +8,6 @@ remarks: |- Returned by the mode property of the [Document](xref:office!Office.Document:interface) object. - #### Used by - [Office.Document](/javascript/api/office/office.document): [mode](/javascript/api/office/office.document#office-office-document-mode-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.eventtype.yml b/docs/docs-ref-autogen/office_release/office/office.eventtype.yml index 6271e1bb13..6537ba08eb 100644 --- a/docs/docs-ref-autogen/office_release/office/office.eventtype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.eventtype.yml @@ -12,6 +12,7 @@ summary: |- remarks: |- + #### Used by - [Office.AppointmentCompose](/javascript/api/outlook/office.appointmentcompose): [addHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1)), [removeHandlerAsync](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.file.yml b/docs/docs-ref-autogen/office_release/office/office.file.yml index 5b52259d88..a486005b32 100644 --- a/docs/docs-ref-autogen/office_release/office/office.file.yml +++ b/docs/docs-ref-autogen/office_release/office/office.file.yml @@ -8,7 +8,6 @@ remarks: |- Access the File object with the AsyncResult.value property in the callback function passed to the Document.getFileAsync method. - #### Used by - [Office.Document](/javascript/api/office/office.document): [getFileAsync](/javascript/api/office/office.document#office-office-document-getfileasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.fileproperties.yml b/docs/docs-ref-autogen/office_release/office/office.fileproperties.yml index 469c5c9902..80e6e1aafd 100644 --- a/docs/docs-ref-autogen/office_release/office/office.fileproperties.yml +++ b/docs/docs-ref-autogen/office_release/office/office.fileproperties.yml @@ -7,6 +7,7 @@ summary: '' remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getFilePropertiesAsync](/javascript/api/office/office.document#office-office-document-getfilepropertiesasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.filetype.yml b/docs/docs-ref-autogen/office_release/office/office.filetype.yml index 221ccda36c..8905a0d49b 100644 --- a/docs/docs-ref-autogen/office_release/office/office.filetype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.filetype.yml @@ -7,6 +7,7 @@ summary: Specifies the format in which to return the document. remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getFileAsync](/javascript/api/office/office.document#office-office-document-getfileasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.filtertype.yml b/docs/docs-ref-autogen/office_release/office/office.filtertype.yml index 241071f4ec..167cc61daa 100644 --- a/docs/docs-ref-autogen/office_release/office/office.filtertype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.filtertype.yml @@ -7,6 +7,7 @@ summary: Specifies whether filtering from the Office application is applied when remarks: |- + #### Used by - [Office.GetBindingDataOptions](/javascript/api/office/office.getbindingdataoptions): [filterType](/javascript/api/office/office.getbindingdataoptions#office-office-getbindingdataoptions-filtertype-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.getselecteddataoptions.yml b/docs/docs-ref-autogen/office_release/office/office.getselecteddataoptions.yml index 46896f1f30..826cc85b90 100644 --- a/docs/docs-ref-autogen/office_release/office/office.getselecteddataoptions.yml +++ b/docs/docs-ref-autogen/office_release/office/office.getselecteddataoptions.yml @@ -7,6 +7,7 @@ summary: Provides options for customizing what data is returned and how it is fo remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getSelectedDataAsync](/javascript/api/office/office.document#office-office-document-getselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.gototype.yml b/docs/docs-ref-autogen/office_release/office/office.gototype.yml index 30fb1022e3..8e013fbd1d 100644 --- a/docs/docs-ref-autogen/office_release/office/office.gototype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.gototype.yml @@ -7,6 +7,7 @@ summary: Specifies the type of place or object to navigate to. remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [goToByIdAsync](/javascript/api/office/office.document#office-office-document-gotobyidasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.group.yml b/docs/docs-ref-autogen/office_release/office/office.group.yml index c98977c894..5b04861017 100644 --- a/docs/docs-ref-autogen/office_release/office/office.group.yml +++ b/docs/docs-ref-autogen/office_release/office/office.group.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.Tab](/javascript/api/office/office.tab): [groups](/javascript/api/office/office.tab#office-office-tab-groups-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.hosttype.yml b/docs/docs-ref-autogen/office_release/office/office.hosttype.yml index 6a64966ba2..c99fa196e1 100644 --- a/docs/docs-ref-autogen/office_release/office/office.hosttype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.hosttype.yml @@ -8,7 +8,6 @@ remarks: |- **Important**: In Outlook, this enum is available starting with Mailbox requirement set 1.5. - #### Used by - [Office](/javascript/api/office): [onReady](/javascript/api/office#office-office-onready-function(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.initializationreason.yml b/docs/docs-ref-autogen/office_release/office/office.initializationreason.yml index d3e22663ed..5800b8f58c 100644 --- a/docs/docs-ref-autogen/office_release/office/office.initializationreason.yml +++ b/docs/docs-ref-autogen/office_release/office/office.initializationreason.yml @@ -7,6 +7,7 @@ summary: Specifies whether the add-in was just inserted or was already contained remarks: |- + #### Used by - [Office](/javascript/api/office): [initialize](/javascript/api/office#office-office-initialize-function(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.officetheme.yml b/docs/docs-ref-autogen/office_release/office/office.officetheme.yml index df809432e0..54e544f596 100644 --- a/docs/docs-ref-autogen/office_release/office/office.officetheme.yml +++ b/docs/docs-ref-autogen/office_release/office/office.officetheme.yml @@ -15,7 +15,6 @@ remarks: |- **Important**: In Outlook, the Office theme API is supported starting in [Mailbox requirement set 1.14](https://learn.microsoft.com/javascript/api/requirement-sets/outlook/outlook-requirement-set-1-14). It isn't supported in Outlook add-ins that implement [event-based activation](https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation). - #### Used by - [Office.Context](/javascript/api/office/office.context): [officeTheme](/javascript/api/office/office.context#office-office-context-officetheme-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.platformtype.yml b/docs/docs-ref-autogen/office_release/office/office.platformtype.yml index 600578bb99..70753b1314 100644 --- a/docs/docs-ref-autogen/office_release/office/office.platformtype.yml +++ b/docs/docs-ref-autogen/office_release/office/office.platformtype.yml @@ -8,7 +8,6 @@ remarks: |- **Important**: In Outlook, this enum is available starting with Mailbox requirement set 1.5. - #### Used by - [Office](/javascript/api/office): [onReady](/javascript/api/office#office-office-onready-function(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.rangecoordinates.yml b/docs/docs-ref-autogen/office_release/office/office.rangecoordinates.yml index d34527ce43..bbe5920481 100644 --- a/docs/docs-ref-autogen/office_release/office/office.rangecoordinates.yml +++ b/docs/docs-ref-autogen/office_release/office/office.rangecoordinates.yml @@ -7,6 +7,7 @@ summary: 'Specifies a cell, or row, or column, by its zero-based row and/or colu remarks: |- + #### Used by - [Office.RangeFormatConfiguration](/javascript/api/office/office.rangeformatconfiguration): [cells](/javascript/api/office/office.rangeformatconfiguration#office-office-rangeformatconfiguration-cells-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.rangeformatconfiguration.yml b/docs/docs-ref-autogen/office_release/office/office.rangeformatconfiguration.yml index 89a7e7e655..56dcad4b2f 100644 --- a/docs/docs-ref-autogen/office_release/office/office.rangeformatconfiguration.yml +++ b/docs/docs-ref-autogen/office_release/office/office.rangeformatconfiguration.yml @@ -7,6 +7,7 @@ summary: Specifies a range and its formatting. remarks: |- + #### Used by - [Office.SetBindingDataOptions](/javascript/api/office/office.setbindingdataoptions): [cellFormat](/javascript/api/office/office.setbindingdataoptions#office-office-setbindingdataoptions-cellformat-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.requirementsetsupport.yml b/docs/docs-ref-autogen/office_release/office/office.requirementsetsupport.yml index 975b1b7bbc..88f8de208e 100644 --- a/docs/docs-ref-autogen/office_release/office/office.requirementsetsupport.yml +++ b/docs/docs-ref-autogen/office_release/office/office.requirementsetsupport.yml @@ -7,6 +7,7 @@ summary: Provides information about which Requirement Sets are supported in the remarks: |- + #### Used by - [Office.Context](/javascript/api/office/office.context): [requirements](/javascript/api/office/office.context#office-office-context-requirements-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.savesettingsoptions.yml b/docs/docs-ref-autogen/office_release/office/office.savesettingsoptions.yml index 05c929c57a..cfb6bd57fd 100644 --- a/docs/docs-ref-autogen/office_release/office/office.savesettingsoptions.yml +++ b/docs/docs-ref-autogen/office_release/office/office.savesettingsoptions.yml @@ -7,6 +7,7 @@ summary: Provides options for saving settings. remarks: |- + #### Used by - [Office.Settings](/javascript/api/office/office.settings): [saveAsync](/javascript/api/office/office.settings#office-office-settings-saveasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.setselecteddataoptions.yml b/docs/docs-ref-autogen/office_release/office/office.setselecteddataoptions.yml index 09af13c34e..122eade654 100644 --- a/docs/docs-ref-autogen/office_release/office/office.setselecteddataoptions.yml +++ b/docs/docs-ref-autogen/office_release/office/office.setselecteddataoptions.yml @@ -7,6 +7,7 @@ summary: Provides options for how to insert data to the selection. remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [setSelectedDataAsync](/javascript/api/office/office.document#office-office-document-setselecteddataasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.slice.yml b/docs/docs-ref-autogen/office_release/office/office.slice.yml index 26b842671f..5846664057 100644 --- a/docs/docs-ref-autogen/office_release/office/office.slice.yml +++ b/docs/docs-ref-autogen/office_release/office/office.slice.yml @@ -7,6 +7,7 @@ summary: Represents a slice of a document file. The Slice object is accessed wit remarks: |- + #### Used by - [Office.File](/javascript/api/office/office.file): [getSliceAsync](/javascript/api/office/office.file#office-office-file-getsliceasync-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.sliderange.yml b/docs/docs-ref-autogen/office_release/office/office.sliderange.yml index fd682421e7..f3fcc4a342 100644 --- a/docs/docs-ref-autogen/office_release/office/office.sliderange.yml +++ b/docs/docs-ref-autogen/office_release/office/office.sliderange.yml @@ -7,6 +7,7 @@ summary: Represents the selected slides in a PowerPoint presentation. This objec remarks: |- + #### Used by - [Office.Document](/javascript/api/office/office.document): [getSelectedDataAsync](/javascript/api/office/office.document#office-office-document-getselecteddataasync-member(4)) diff --git a/docs/docs-ref-autogen/office_release/office/office.startupbehavior.yml b/docs/docs-ref-autogen/office_release/office/office.startupbehavior.yml index 30fa550ad0..23772ab49c 100644 --- a/docs/docs-ref-autogen/office_release/office/office.startupbehavior.yml +++ b/docs/docs-ref-autogen/office_release/office/office.startupbehavior.yml @@ -7,6 +7,7 @@ summary: Provides options to determine the startup behavior of the add-in upon n remarks: |- + #### Used by - [Office.Addin](/javascript/api/office/office.addin): [getStartupBehavior](/javascript/api/office/office.addin#office-office-addin-getstartupbehavior-member(1)), [setStartupBehavior](/javascript/api/office/office.addin#office-office-addin-setstartupbehavior-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/office.tab.yml b/docs/docs-ref-autogen/office_release/office/office.tab.yml index 4c2a7ba006..855d21c925 100644 --- a/docs/docs-ref-autogen/office_release/office/office.tab.yml +++ b/docs/docs-ref-autogen/office_release/office/office.tab.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [RibbonApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets) - #### Used by - [Office.RibbonUpdaterData](/javascript/api/office/office.ribbonupdaterdata): [tabs](/javascript/api/office/office.ribbonupdaterdata#office-office-ribbonupdaterdata-tabs-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.taskpane.yml b/docs/docs-ref-autogen/office_release/office/office.taskpane.yml index e65e942154..a4f52a0792 100644 --- a/docs/docs-ref-autogen/office_release/office/office.taskpane.yml +++ b/docs/docs-ref-autogen/office_release/office/office.taskpane.yml @@ -8,7 +8,6 @@ remarks: |- **Requirement set**: [TaskPaneApi 1.1](https://learn.microsoft.com/javascript/api/requirement-sets/common/task-pane-api-requirement-sets) - #### Used by - [Office.ExtensionLifeCycle](/javascript/api/office/office.extensionlifecycle): [taskpane](/javascript/api/office/office.extensionlifecycle#office-office-extensionlifecycle-taskpane-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.themeid.yml b/docs/docs-ref-autogen/office_release/office/office.themeid.yml index 4d00b354bb..334f7f6f6b 100644 --- a/docs/docs-ref-autogen/office_release/office/office.themeid.yml +++ b/docs/docs-ref-autogen/office_release/office/office.themeid.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.OfficeTheme](/javascript/api/office/office.officetheme): [themeId](/javascript/api/office/office.officetheme#office-office-officetheme-themeid-member) 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 c48713108d..4a8f6382e9 100644 --- a/docs/docs-ref-autogen/office_release/office/office.ui.yml +++ b/docs/docs-ref-autogen/office_release/office/office.ui.yml @@ -10,6 +10,7 @@ summary: |- remarks: |- + #### Used by - [Office.Context](/javascript/api/office/office.context): [ui](/javascript/api/office/office.context#office-office-context-ui-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.valueformat.yml b/docs/docs-ref-autogen/office_release/office/office.valueformat.yml index c3d5b02381..e88a29391d 100644 --- a/docs/docs-ref-autogen/office_release/office/office.valueformat.yml +++ b/docs/docs-ref-autogen/office_release/office/office.valueformat.yml @@ -8,7 +8,6 @@ remarks: |- For example, if the valueFormat parameter is specified as "formatted", a number formatted as currency, or a date formatted as mm/dd/yy in the Office application will have its formatting preserved. If the valueFormat parameter is specified as "unformatted", a date will be returned in its underlying sequential serial number form. - #### Used by - [Office.GetBindingDataOptions](/javascript/api/office/office.getbindingdataoptions): [valueFormat](/javascript/api/office/office.getbindingdataoptions#office-office-getbindingdataoptions-valueformat-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.visibilitymode.yml b/docs/docs-ref-autogen/office_release/office/office.visibilitymode.yml index b2fedeca63..2da25446f3 100644 --- a/docs/docs-ref-autogen/office_release/office/office.visibilitymode.yml +++ b/docs/docs-ref-autogen/office_release/office/office.visibilitymode.yml @@ -7,6 +7,7 @@ summary: Visibility mode of the add-in. remarks: |- + #### Used by - [Office.VisibilityModeChangedMessage](/javascript/api/office/office.visibilitymodechangedmessage): [visibilityMode](/javascript/api/office/office.visibilitymodechangedmessage#office-office-visibilitymodechangedmessage-visibilitymode-member) diff --git a/docs/docs-ref-autogen/office_release/office/office.visibilitymodechangedmessage.yml b/docs/docs-ref-autogen/office_release/office/office.visibilitymodechangedmessage.yml index 81b53af6d8..d7b24c800e 100644 --- a/docs/docs-ref-autogen/office_release/office/office.visibilitymodechangedmessage.yml +++ b/docs/docs-ref-autogen/office_release/office/office.visibilitymodechangedmessage.yml @@ -7,6 +7,7 @@ summary: Message used in the `onVisibilityModeChanged` invocation. remarks: |- + #### Used by - [Office.Addin](/javascript/api/office/office.addin): [onVisibilityModeChanged](/javascript/api/office/office.addin#office-office-addin-onvisibilitymodechanged-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml b/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml index ee8d8dd1e5..5815d050e1 100644 --- a/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml +++ b/docs/docs-ref-autogen/office_release/office/officeextension.clientresult.yml @@ -7,6 +7,7 @@ summary: Contains the result for methods that return primitive types. The object remarks: |- + #### Used by - [Excel.AllowEditRangeCollection](/javascript/api/excel/excel.alloweditrangecollection): [getCount](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getcount-member(1)) diff --git a/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml b/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml index e69dd6896b..27f21843b0 100644 --- a/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml +++ b/docs/docs-ref-autogen/office_release/office/officeextension.loadoption.yml @@ -20,7 +20,6 @@ remarks: |- Note that if we don't specify the specific properties on the font object in the select statement, the expand statement by itself would indicate that all of the font properties are loaded. - #### Used by - [Excel.AllowEditRangeCollection](/javascript/api/excel/excel.alloweditrangecollection): [load](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-load-member(3)) diff --git a/docs/docs-ref-autogen/office_release/office/officeextension.updateoptions.yml b/docs/docs-ref-autogen/office_release/office/officeextension.updateoptions.yml index e90ad0da7f..1fc3288d80 100644 --- a/docs/docs-ref-autogen/office_release/office/officeextension.updateoptions.yml +++ b/docs/docs-ref-autogen/office_release/office/officeextension.updateoptions.yml @@ -7,6 +7,7 @@ summary: Provides an option for suppressing an error when the object that is use remarks: |- + #### Used by - [Excel.AllowEditRange](/javascript/api/excel/excel.alloweditrange): [set](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-set-member(1)) diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 00843bdacb..4187e2a99e 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -8328,9 +8328,9 @@ office-runtime,OfficeRuntime.AuthOptions,"authChallenge",Property,Excellent,fals office-runtime,OfficeRuntime.AuthOptions,"forceAddAccount",Property,Deprecated,false office-runtime,OfficeRuntime.AuthOptions,"forceConsent",Property,Deprecated,false office-runtime,OfficeRuntime.AuthOptions,"forMSGraphAccess",Property,Excellent,false -office-runtime,OfficeRuntime.Dialog,N/A,Interface,Fine,false +office-runtime,OfficeRuntime.Dialog,N/A,Interface,Fine,true office-runtime,OfficeRuntime.Dialog,"close()",Method,Good,false -office-runtime,OfficeRuntime.DisplayWebDialogOptions,N/A,Interface,Fine,false +office-runtime,OfficeRuntime.DisplayWebDialogOptions,N/A,Interface,Fine,true office-runtime,OfficeRuntime.DisplayWebDialogOptions,"displayInIFrame",Property,Excellent,false office-runtime,OfficeRuntime.DisplayWebDialogOptions,"height",Property,Excellent,false office-runtime,OfficeRuntime.DisplayWebDialogOptions,"onClose",Property,Great,false diff --git a/generate-docs/script-inputs/local-repo-snippets.yaml b/generate-docs/script-inputs/local-repo-snippets.yaml index 5ee318f05f..2b8bfdf727 100644 --- a/generate-docs/script-inputs/local-repo-snippets.yaml +++ b/generate-docs/script-inputs/local-repo-snippets.yaml @@ -7099,6 +7099,48 @@ OfficeRuntime.Auth#getAccessToken:member(1): } } } +OfficeRuntime.AuthOptions:interface: + - |- + const options: OfficeRuntime.AuthOptions = { + allowSignInPrompt: true, + allowConsentPrompt: true, + forMSGraphAccess: true, + }; + const accessToken = await OfficeRuntime.auth.getAccessToken(options); +OfficeRuntime.Dialog:interface: + - |- + const dialogUrl = "https://your-addin-domain.com/dialog.html"; + const dialogOptions: OfficeRuntime.DisplayWebDialogOptions = { + height: "50%", + width: "50%", + displayInIFrame: false, + onMessage: function (message: string, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog result: " + message); + }, + onRuntimeError: function (error: Error, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog error: " + error.message); + }, + } + OfficeRuntime.displayWebDialog(dialogUrl, dialogOptions); +OfficeRuntime.DisplayWebDialogOptions:interface: + - |- + const dialogUrl = "https://your-addin-domain.com/dialog.html"; + const dialogOptions: OfficeRuntime.DisplayWebDialogOptions = { + height: "50%", + width: "50%", + displayInIFrame: false, + onMessage: function (message: string, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog result: " + message); + }, + onRuntimeError: function (error: Error, dialog?: OfficeRuntime.Dialog) { + dialog?.close(); + console.log("Dialog error: " + error.message); + }, + } + OfficeRuntime.displayWebDialog(dialogUrl, dialogOptions); OfficeRuntime.Storage#getItem:member(1): - |- // Retrieve a value from the shared runtime storage by its key.