office-runtime package

Interfaces

OfficeRuntime.ApiInformation

Interface that contains methods for checking API requirement-set support.

OfficeRuntime.Auth

Interface that contains authorization related APIs.

OfficeRuntime.AuthOptions

Provides options for the user experience when Office obtains an access token to the add-in from AAD v. 2.0 with the getAccessToken method.

OfficeRuntime.Dialog

Object representing the dialog box.

OfficeRuntime.DisplayWebDialogOptions

Provides display options and actions a dialog box may take.

OfficeRuntime.Storage

Asynchronous, global, and persistent key-value storage.

Functions

OfficeRuntime.displayWebDialog(url, options)

Function that enables a pop up web dialog box.

Function Details

OfficeRuntime.displayWebDialog(url, options)

Function that enables a pop up web dialog box.

export function displayWebDialog(url: string, options?: DisplayWebDialogOptions): Promise<Dialog>;

Parameters

url

string

Must be a string.

options
OfficeRuntime.DisplayWebDialogOptions

Optional parameter. Must be of type DisplayWebDialogOptions.

Returns

Remarks

[ API set: CustomFunctionsRuntime 1.1 ]