Partilhar via

contexto (conjunto de requisitos de visualização da caixa de correio)

  • Artigo

Office.context

O Office.context fornece interfaces compartilhadas que são usadas por suplementos em todos os aplicativos do Office. Esta listagem documenta apenas as interfaces usados pelos suplementos do Outlook. Para uma listagem completa do namespace Office.context, veja a referência Office.context na API Comum.

Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1.1
Modo do Outlook aplicável Escrever ou Ler

Propriedades

Propriedade Modos Tipo de retorno Minimum
conjunto de requisitos
Auth Escrever
Leitura		 Auth IdentityAPI 1.3
contentLanguage Escrever
Leitura		 Cadeia de caracteres 1.1
diagnóstico Escrever
Leitura		 ContextInformation 1.5
displayLanguage Escrever
Leitura		 Cadeia de caracteres 1.1
Host Escrever
Leitura		 HostType 1.5
mailbox Escrever
Leitura		 Caixa de Correio 1.1
officeTheme Escrever
Leitura		 OfficeTheme 11.4
Plataforma Escrever
Leitura		 PlatformType 1.5
Requisitos Escrever
Leitura		 RequirementSetSupport 1.1
roamingSettings Escrever
Leitura		 RoamingSettings 1.1
sensitivityLabelsCatalog Escrever SensitivityLabelsCatalog 1.13
ui Escrever
Leitura		 UI 1.1
Urls Escrever
Leitura		 URLs 11.4

Detalhes da propriedade

auth: Auth

Dá suporte ao SSO (logon único) fornecendo um método que permite que o aplicativo do Office obtenha um token de acesso ao aplicativo Web do suplemento. Indiretamente, isso também habilita o suplemento para acessar os dados do Microsoft Graph do usuário sem exigir que o usuário se conecte uma segunda vez.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio Visualização
Modo do Outlook aplicável Escrever ou Ler
Exemplo
Office.context.auth.getAccessTokenAsync(function(result) {
    if (result.status === "succeeded") {
        const token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

contentLanguage: String

Obtém a localidade (idioma) especificada pelo usuário para edição do item.

O contentLanguage valor reflete a configuração atual de Linguagem de Edição especificada com Linguagem de Opções > de Arquivo > no aplicativo cliente do Office.

Tipo
  • String
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1.1
Modo do Outlook aplicável Escrever ou Ler
Exemplo
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;
}

diagnóstico: ContextInformation

Obtém informações sobre o ambiente em que o suplemento está em execução.

Observação

Para todos os conjuntos de requisitos da caixa de correio, você também pode usar a propriedade Office.context.mailbox.diagnóstico para obter informações semelhantes.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1,5
Modo do Outlook aplicável Escrever ou Ler
Exemplo
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);

displayLanguage: String

Obtém a localidade (idioma) no formato de marca de linguagem RFC 1766 especificado pelo usuário para a interface do usuário do aplicativo cliente do Office.

O displayLanguage valor reflete a configuração atual da Linguagem de Exibição especificada comLinguagemde Opções> de Arquivo> no aplicativo cliente do Office.

Tipo
  • String
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1.1
Modo do Outlook aplicável Escrever ou Ler
Exemplo
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

Obtém o aplicativo do Office que está hospedando o suplemento.

Observação

Como alternativa, você pode usar a propriedade Office.context.diagnóstico para obter o host. Para todos os conjuntos de requisitos da caixa de correio, você também pode usar a propriedade Office.context.mailbox.diagnóstico para obter informações semelhantes.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1,5
Modo do Outlook aplicável Escrever ou Ler
Exemplo
console.log(JSON.stringify(Office.context.host));

officeTheme: OfficeTheme

Fornece acesso às propriedades de cores de temas do Office.

Observação

Esse membro só tem suporte no Outlook no Windows.

O uso das cores do tema do Office permite coordenar o esquema de cores do suplemento com o tema atual do Office selecionado pelo usuário com a interface do usuário do Tema do Office da Conta > do Office de Arquivos>, que é aplicada em todos os aplicativos cliente do Office. Usar cores de temas do Office é apropriado suplementos de email e painéis de tarefas.

Tipo
Propriedades
Nome Tipo Descrição
bodyBackgroundColor String Obtém a cor de plano de fundo do corpo de tema do Office como um tripleto hexadecimal de cores.
bodyForegroundColor String Obtém a cor de primeiro plano do corpo de tema do Office como um tripleto hexadecimal de cores.
controlBackgroundColor String Obtém a cor de plano de fundo do controle do tema do Office como um tripleto hexadecimal de cores.
controlForegroundColor String Obtém a cor de controle do corpo de tema do Office como um tripleto hexadecimal de cores.
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio Visualização
Modo do Outlook aplicável Escrever ou Ler
Exemplo
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);
}

plataforma: PlatformType

Fornece a plataforma na qual o suplemento está em execução.

Observação

Como alternativa, você pode usar a propriedade Office.context.diagnóstico para obter a plataforma. Para todos os conjuntos de requisitos da caixa de correio, você também pode usar a propriedade Office.context.mailbox.diagnóstico para obter informações semelhantes.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1,5
Modo do Outlook aplicável Escrever ou Ler
Exemplo
console.log(JSON.stringify(Office.context.platform));

requisitos: RequirementSetSupport

Fornece um método para determinar quais conjuntos de requisitos têm suporte no aplicativo e na plataforma atuais.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1.1
Modo do Outlook aplicável Escrever ou Ler
Exemplo
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));

roamingSettings: RoamingSettings

Obtém um objeto que representa as configurações personalizadas ou o estado de um suplemento de email do Outlook salvos na caixa de correio do usuário.

O RoamingSettings objeto permite armazenar e acessar dados de um suplemento de email armazenado na caixa de correio de um usuário, de modo que esteja disponível para esse suplemento quando ele estiver em execução de qualquer cliente do Outlook usado para acessar essa caixa de correio.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1.1
Nível de permissão mínimo Restrito
Modo do Outlook aplicável Escrever ou Ler

sensitivityLabelsCatalog: SensitivityLabelsCatalog

Obtém o objeto para marcar o status do catálogo de rótulos de confidencialidade no Outlook e recuperar todos os rótulos de confidencialidade disponíveis se o catálogo estiver habilitado.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1.13
Nível de permissão mínimo item de leitura/gravação
Modo do Outlook aplicável Escrever

interface do usuário: interface do usuário

Fornece objetos e métodos que você pode usar para criar e manipular componentes da interface do usuário, como caixas de diálogo, em seus Suplementos do Office.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 1.1
Modo do Outlook aplicável Escrever ou Ler

urls: Urls

Obtém o objeto para recuperar as URLs de runtime de um suplemento.

Tipo
Requisitos
Requisito Valor
Versão do conjunto de requisitos mínimos da caixa de correio 11.4
Modo do Outlook aplicável Escrever ou Ler

Eventos

Você pode assinar e cancelar a assinatura dos eventos a seguir usando addHandlerAsync e removerHandlerAsync , respectivamente.

Event Descrição Minimum
conjunto de requisitos
OfficeThemeChanged O tema do Office no Outlook foi alterado. Disponível apenas com a implementação do painel de tarefas. 11.4