office-runtime package

Interfaces

OfficeRuntime.ApiInformation

Interface que contém métodos para verificar o suporte ao conjunto de requisitos da API.
OfficeRuntime.Auth

Interface que contém APIs relacionadas à autorização.
OfficeRuntime.AuthOptions

Fornece opções para a experiência do usuário quando o Office obtém um token de acesso para o suplemento do AAD v. 2.0 com o getAccessToken método.
OfficeRuntime.Dialog

Objeto que representa a caixa de diálogo.
OfficeRuntime.DisplayWebDialogOptions

Fornece opções de exibição e ações que uma caixa de diálogo pode executar.
OfficeRuntime.Storage

Armazenamento de chave-valor assíncrono, global e persistente.

Funções

OfficeRuntime.displayWebDialog(url, options)

Função que habilita uma caixa de diálogo pop-up da Web.

Detalhes da função

OfficeRuntime.displayWebDialog(url, options)

Função que habilita uma caixa de diálogo pop-up da Web.

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

Parâmetros

url

string

Deve ser uma cadeia de caracteres.

options
OfficeRuntime.DisplayWebDialogOptions

Parâmetro opcional. Deve ser do tipo DisplayWebDialogOptions.

Retornos

Promise<OfficeRuntime.Dialog>

Comentários

Conjunto de APIs: CustomFunctionsRuntime 1.1

Exemplos

/**
 * Opens an authentication dialog from a custom function.
 * @customfunction AUTH.LOGIN
 * @returns A promise that resolves to the authentication result.
 */
async function authLogin(): Promise<string> {
  const dialogUrl = "https://your-addin-domain.com/auth-dialog.html";

  return new Promise((resolve, reject) => {
    OfficeRuntime.displayWebDialog(dialogUrl, {
      height: "50%",
      width: "40%",

      onMessage: (message: string, dialog?: OfficeRuntime.Dialog) => {
        // Handle messages sent from the dialog via window.opener.postMessage().
        const data = JSON.parse(message);

        if (data.type === "auth-success") {
          // Process the authentication token
          dialog?.close();
          resolve(`Signed in as ${data.username}`);
        } else if (data.type === "auth-error") {
          dialog?.close();
          reject(new Error(data.errorMessage));
        }
      },

      onClose: () => {
        // Handle the user closing the dialog.
        resolve("Dialog closed");
      },

      onRuntimeError: (error: Error, dialog?: OfficeRuntime.Dialog) => {
        // Handle runtime errors from the dialog.
        dialog?.close();
        reject(error);
      },
    }).catch((error) => {
      reject(new Error(`Failed to open dialog: ${error.message}`));
    });
  });
}