Compartir a través de

Office.Ews interface

Paquete:
outlook

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Proporciona métodos para determinar si los tokens de devolución de llamada de Exchange Web Services (EWS) se admiten en una organización.

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante: los tokens de identidad de usuario y los tokens de devolución de llamada heredados Exchange Online ya no se admiten y se desactivan en todos los inquilinos de Microsoft 365. Si un complemento de Outlook requiere acceso de usuario delegado o identidad de usuario, se recomienda usar MSAL (Biblioteca de autenticación de Microsoft) y la autenticación de aplicaciones anidadas (NAA). Los tokens de identidad de usuario de Exchange siguen siendo compatibles con Exchange local. Para obtener más información, consulte Preguntas más frecuentes sobre la autenticación de aplicaciones anidadas.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-token-status.yaml

Office.context.mailbox.diagnostics.ews.getTokenStatusAsync({ isRest: false }, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }
  const status = result.value;
  switch (status) {
    case Office.MailboxEnums.TokenStatus.Enabled:
      console.log("EWS callback tokens are enabled.");
      break;
    case Office.MailboxEnums.TokenStatus.Disabled:
      console.log("EWS callback tokens are disabled.");
      break;
    case Office.MailboxEnums.TokenStatus.Removed:
      console.log(
        "The organization has an Exchange Online environment. Legacy Exchange tokens are no longer supported.",
      );
      break;
  }
});

Métodos

getTokenStatusAsync(options, callback)

Obtiene el estado de los tokens de devolución de llamada de EWS en una organización.
getTokenStatusAsync(callback)

Obtiene el estado de los tokens de devolución de llamada de EWS en una organización.

Detalles del método

getTokenStatusAsync(options, callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el estado de los tokens de devolución de llamada de EWS en una organización.

getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;

Parámetros

options

Office.AsyncContextOptions & { isRest?: boolean }

Un objeto literal que contiene una o más de las siguientes propiedades. asyncContext : cualquier dato al que quiera acceder en la función de devolución de llamada. isRest : identifica si el token necesario es para las API REST de EWS o Outlook. De forma predeterminada, la isRest propiedad se establece en false.

callback

(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. La asyncResult.value propiedad devuelve el estado del token, que puede serOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabledo Office.MailboxEnums.TokenStatus.Removed. Un Office.MailboxEnums.TokenStatus.Removed estado indica que el buzón se hospeda en un entorno de Exchange Online donde los tokens de Exchange heredados están desactivados y ya no se admiten.

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante:

  • El getTokenStatusAsync método está disponible para la versión preliminar en Outlook en la Web y en Windows (nuevo y clásico (versión 2510, compilación 19328.20000 y versiones posteriores)).

  • El getTokenStatusAsync método no se admite si carga un complemento en un buzón de correo de Outlook.com o Gmail.

  • Llamar al getTokenStatusAsync método en modo de redacción requiere que haya guardado el elemento. El saveAsync método requiere un nivel de permiso mínimo de elemento de lectura y escritura.

getTokenStatusAsync(callback)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el estado de los tokens de devolución de llamada de EWS en una organización.

getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.MailboxEnums.TokenStatus>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. La asyncResult.value propiedad devuelve el estado del token, que puede serOffice.MailboxEnums.TokenStatus.Enabled , Office.MailboxEnums.TokenStatus.Disabledo Office.MailboxEnums.TokenStatus.Removed. Un Office.MailboxEnums.TokenStatus.Removed estado indica que el buzón se hospeda en un entorno de Exchange Online donde los tokens de Exchange heredados están desactivados y ya no se admiten.

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Importante:

  • El getTokenStatusAsync método está disponible para la versión preliminar en Outlook en la Web y en Windows (nuevo y clásico (versión 2510, compilación 19328.20000 y versiones posteriores)).

  • El getTokenStatusAsync método no se admite si carga un complemento en un buzón de correo de Outlook.com o Gmail.

  • Llamar al getTokenStatusAsync método en modo de redacción requiere que haya guardado el elemento. El saveAsync método requiere un nivel de permiso mínimo de elemento de lectura y escritura.