Share via

context (conjunto de requisitos de la versión preliminar del buzón)

  • Artículo

Office.context

Office.context proporciona interfaces compartidas que usan los complementos en todas las aplicaciones de Office. Esta lista solo documenta las interfaces que usan los complementos de Outlook. Para obtener una lista completa del espacio de nombres Office.context, consulte la referencia de Office.context en common API.

Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.1
Modo de Outlook aplicable Redacción o lectura

Propiedades

Propiedad Modos Tipo devuelto Mínimo
conjunto de requisitos
Auth Redacción
Lectura		 Auth IdentityAPI 1.3
contentLanguage Redacción
Lectura		 Cadena 1.1
Diagnóstico Redacción
Lectura		 ContextInformation 1.5
displayLanguage Redacción
Lectura		 Cadena 1.1
Host Redacción
Lectura		 HostType 1.5
mailbox Redacción
Lectura		 Buzón 1.1
officeTheme Redacción
Lectura		 OfficeTheme 1.14
Plataforma Redacción
Lectura		 Platform Type 1.5
Requisitos Redacción
Lectura		 RequirementSetSupport 1.1
roamingSettings Redacción
Lectura		 RoamingSettings 1.1
sensitivityLabelsCatalog Redacción SensitivityLabelsCatalog 1.13
ui Redacción
Lectura		 UI 1.1
Url Redacción
Lectura		 Urls 1.14

Detalles de la propiedad

auth: Auth

Admite el inicio de sesión único (SSO) proporcionando un método que permite a la aplicación de Office obtener un token de acceso a la aplicación web del complemento. Indirectamente, esto habilita el complemento para que tenga acceso a los datos del usuario que ha iniciado sesión en Microsoft Graph, sin que el usuario inicie sesión por segunda vez.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón Preview
Modo de Outlook aplicable Redacción o lectura
Ejemplo
Office.context.auth.getAccessTokenAsync(function(result) {
    if (result.status === "succeeded") {
        const token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

contentLanguage: String

Obtiene la configuración regional (idioma) especificada por el usuario para editar el elemento.

El contentLanguage valor refleja la configuración de idioma de edición actual especificada con El lenguaje de opciones > de archivo > en la aplicación cliente de Office.

Tipo
  • Cadena
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.1
Modo de Outlook aplicable Redacción o lectura
Ejemplo
function sayHelloWithContentLanguage() {
  const myContentLanguage = Office.context.contentLanguage;
  switch (myContentLanguage) {
    case 'en-US':
      write('Hello!');
      break;
    case 'en-NZ':
      write('G\'day mate!');
      break;
  }
}

// Function that writes to a div with id='message' on the page.
function write(message){
  document.getElementById('message').innerText += message;
}

diagnostics: ContextInformation

Obtiene información sobre el entorno en el que se ejecuta el complemento.

Nota:

Para todos los conjuntos de requisitos de buzón, también puede usar la propiedad Office.context.mailbox.diagnostics para obtener información similar.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1,5
Modo de Outlook aplicable Redacción o lectura
Ejemplo
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);

displayLanguage: String

Obtiene la configuración regional (idioma) en formato de etiqueta de idioma RFC 1766 especificado por el usuario para la interfaz de usuario de la aplicación cliente de Office.

El displayLanguage valor refleja la configuración de idioma de presentación actual especificada conEl lenguajede opciones> de archivo> en la aplicación cliente de Office.

Tipo
  • Cadena
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.1
Modo de Outlook aplicable Redacción o lectura
Ejemplo
function sayHelloWithDisplayLanguage() {
  const myDisplayLanguage = Office.context.displayLanguage;
  switch (myDisplayLanguage) {
    case 'en-US':
      write('Hello!');
      break;
    case 'en-NZ':
      write('G\'day mate!');
      break;
  }
}

// Function that writes to a div with id='message' on the page.
function write(message){
  document.getElementById('message').innerText += message;
}

host: HostType

Obtiene la aplicación de Office que hospeda el complemento.

Nota:

Como alternativa, puede usar la propiedad Office.context.diagnostics para obtener el host. Para todos los conjuntos de requisitos de buzón, también puede usar la propiedad Office.context.mailbox.diagnostics para obtener información similar.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1,5
Modo de Outlook aplicable Redacción o lectura
Ejemplo
console.log(JSON.stringify(Office.context.host));

officeTheme: OfficeTheme

Proporciona acceso a las propiedades de los colores del tema de Office.

Nota:

Este miembro solo se admite en Outlook en Windows.

El uso de colores de tema de Office le permite coordinar la combinación de colores del complemento con el tema actual de Office seleccionado por el usuario con la interfaz de usuario de tema de Office de la cuenta > de Office de archivo>, que se aplica en todas las aplicaciones cliente de Office. El uso de colores del tema de Office es idóneo para los complementos de correo y panel de tareas.

Tipo
Propiedades
Nombre Tipo Descripción
bodyBackgroundColor String Obtiene el color de fondo del cuerpo del tema de Office como un tríptico de color hexadecimal.
bodyForegroundColor String Obtiene el color de primer plano del cuerpo del tema de Office como un tríptico de color hexadecimal.
controlBackgroundColor String Obtiene el color de fondo del control del tema de Office como un tríptico de color hexadecimal.
controlForegroundColor String Obtiene el color del control del cuerpo del tema de Office como un tríptico de color hexadecimal.
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón Preview
Modo de Outlook aplicable Redacción o lectura
Ejemplo
function applyOfficeTheme(){
  // Get office theme colors.
  const bodyBackgroundColor = Office.context.officeTheme.bodyBackgroundColor;
  const bodyForegroundColor = Office.context.officeTheme.bodyForegroundColor;
  const controlBackgroundColor = Office.context.officeTheme.controlBackgroundColor
  const controlForegroundColor = Office.context.officeTheme.controlForegroundColor;

  // Apply body background color to a CSS class.
  $('.body').css('background-color', bodyBackgroundColor);
}

platform: PlatformType

Proporciona la plataforma en la que se ejecuta el complemento.

Nota:

Como alternativa, puede usar la propiedad Office.context.diagnostics para obtener la plataforma. Para todos los conjuntos de requisitos de buzón, también puede usar la propiedad Office.context.mailbox.diagnostics para obtener información similar.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1,5
Modo de Outlook aplicable Redacción o lectura
Ejemplo
console.log(JSON.stringify(Office.context.platform));

requirements: RequirementSetSupport

Proporciona un método para determinar qué conjuntos de requisitos se admiten en la aplicación y plataforma actuales.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.1
Modo de Outlook aplicable Redacción o lectura
Ejemplo
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));

roamingSettings: RoamingSettings

Obtiene un objeto que representa la configuración o el estado personalizado de un complemento de correo que se guardó en el buzón de un usuario.

El RoamingSettings objeto permite almacenar y acceder a los datos de un complemento de correo que se almacena en el buzón de un usuario, de modo que esté disponible para ese complemento cuando se ejecute desde cualquier cliente de Outlook usado para acceder a ese buzón.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.1
Nivel de permisos mínimo Restringido
Modo de Outlook aplicable Redacción o lectura

sensitivityLabelsCatalog: SensitivityLabelsCatalog

Obtiene el objeto para comprobar el estado del catálogo de etiquetas de confidencialidad en Outlook y recuperar todas las etiquetas de confidencialidad disponibles si el catálogo está habilitado.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.13
Nivel de permisos mínimo elemento de lectura y escritura
Modo de Outlook válido Redacción

ui: UI

Proporciona objetos y métodos que puede usar para crear y manipular componentes de interfaz de usuario, como cuadros de diálogo, en los complementos de Office.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.1
Modo de Outlook aplicable Redacción o lectura

urls: direcciones URL

Obtiene el objeto para recuperar las direcciones URL en tiempo de ejecución de un complemento.

Tipo
Requisitos
Requirement Valor
Versión del conjunto de requisitos mínimos del buzón 1.14
Modo de Outlook aplicable Redacción o lectura

Eventos

Puedes suscribirte y cancelar la suscripción a los siguientes eventos mediante addHandlerAsync y removeHandlerAsync , respectivamente.

Evento Description Mínimo
conjunto de requisitos
OfficeThemeChanged El tema de Office en Outlook cambió. Solo está disponible con la implementación del panel de tareas. 1.14