Office.Diagnostics interface
Proporciona información de diagnóstico a un complemento de Outlook.
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose o lectura
A partir del conjunto de requisitos de buzón 1.5, también puede usar la propiedad Office.context.diagnostics para obtener información similar.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-diagnostic-information.yaml
// This function gets a mailbox's diagnostic information, such as Outlook client and version, and logs it to the console.
const diagnostics = Office.context.mailbox.diagnostics;
console.log(`Client application: ${diagnostics.hostName}`);
console.log(`Client version: ${diagnostics.hostVersion}`);
switch (diagnostics.OWAView) {
case undefined:
console.log("Current view (Outlook on the web only): Not applicable. An Outlook desktop client is in use.");
break;
case Office.MailboxEnums.OWAView.OneColumnNarrow:
console.log("Current view (Outlook on the web only): Viewed from an older generation mobile phone");
break;
case Office.MailboxEnums.OWAView.OneColumn:
console.log("Current view (Outlook on the web only): Viewed from a newer generation mobile phone");
break;
case Office.MailboxEnums.OWAView.TwoColumns:
console.log("Current view (Outlook on the web only): Viewed from a tablet");
break;
case Office.MailboxEnums.OWAView.ThreeColumns:
console.log("Current view (Outlook on the web only): Viewed from a desktop computer");
break;
}
Propiedades
| ews | Obtiene un objeto para identificar si los tokens de devolución de llamada de Exchange Web Services (EWS) son compatibles con una organización. |
| host |
Obtiene una cadena que representa el tipo de cliente de Outlook. La cadena puede ser uno de los siguientes valores: |
| host |
Obtiene una cadena que representa la versión del cliente de Outlook o de la Exchange Server (por ejemplo, "15.0.468.0"). Si el complemento de correo se ejecuta en Outlook en Windows (clásico), en Mac o en dispositivos móviles, la |
| OWAView | Obtiene una cadena que representa la vista actual de Outlook en la Web. La cadena devuelta puede ser uno de los siguientes valores: Si la aplicación no está Outlook en la Web, el acceso a esta propiedad da como resultado undefined. Outlook en la Web tiene tres vistas que se corresponden con el ancho de la pantalla y la ventana, y el número de columnas que se pueden mostrar:
|
Detalles de las propiedades
ews
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 un objeto para identificar si los tokens de devolución de llamada de Exchange Web Services (EWS) son compatibles con una organización.
ews: Ews;
Valor de propiedad
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:
La
ewspropiedad está disponible para la versión preliminar en Outlook en la Web y en Windows (nueva y clásica (versión 2510, compilación 19328.20000 y versiones posteriores)).Los tokens de identidad de usuario y de devolución de llamada de Exchange Online heredados 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;
}
});
hostName
Obtiene una cadena que representa el tipo de cliente de Outlook.
La cadena puede ser uno de los siguientes valores: Outlook, newOutlookWindows, OutlookWebApp, OutlookIOSo OutlookAndroid.
hostName: string;
Valor de propiedad
string
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose o lectura
Importante: El Outlook valor se devuelve para Outlook en Windows (clásico) y en Mac.
newOutlookWindows se devuelve para el nuevo Outlook en Windows.
hostVersion
Obtiene una cadena que representa la versión del cliente de Outlook o de la Exchange Server (por ejemplo, "15.0.468.0").
Si el complemento de correo se ejecuta en Outlook en Windows (clásico), en Mac o en dispositivos móviles, la hostVersion propiedad devuelve la versión del cliente de Outlook. En Outlook en la Web y nueva Outlook en Windows, la propiedad devuelve la versión del Exchange Server.
hostVersion: string;
Valor de propiedad
string
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose o lectura
OWAView
Obtiene una cadena que representa la vista actual de Outlook en la Web.
La cadena devuelta puede ser uno de los siguientes valores: OneColumn, TwoColumnso ThreeColumns.
Si la aplicación no está Outlook en la Web, el acceso a esta propiedad da como resultado undefined.
Outlook en la Web tiene tres vistas que se corresponden con el ancho de la pantalla y la ventana, y el número de columnas que se pueden mostrar:
OneColumn, que se muestra cuando la pantalla es estrecha. Outlook en la Web usa este diseño de una sola columna en toda la pantalla de un smartphone.TwoColumns, que se muestra cuando la pantalla es más ancha. Outlook en la Web usa esta vista en la mayoría de los comprimidos.ThreeColumns, que se muestra cuando la pantalla es ancha. Por ejemplo, Outlook en la Web usa esta vista en una ventana de pantalla completa en un equipo de escritorio.
OWAView: MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns";
Valor de propiedad
Office.MailboxEnums.OWAView | "OneColumn" | "TwoColumns" | "ThreeColumns"
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose o lectura