Verificar a disponibilidade da API em tempo de execução

Se o suplemento usa um recurso de extensibilidade específico para algumas de suas funcionalidades, mas tem outras funcionalidades úteis que não exigem o recurso de extensibilidade, você deve projetar o suplemento para que ele seja instalável em combinações de plataforma e versão do Office que não dão suporte ao recurso de extensibilidade. Pode fornecer uma experiência valiosa, embora reduzida, nessas combinações.

Quando a diferença entre as duas experiências consistir inteiramente em diferenças nas APIs da Biblioteca JavaScript do Office que são chamadas, e não em quaisquer recursos configurados no manifesto, teste em tempo de execução para descobrir se o cliente Office do usuário dá suporte a um conjunto de requisitos de API. Você também pode testar em runtime se há suporte para APIs que não estão em um conjunto.

Verificar o suporte ao conjunto de requisitos

Use o método isSetSupported para marcar o suporte ao conjunto de requisitos. Passe o nome do conjunto de requisitos e a versão mínima como parâmetros. Se o conjunto de requisitos for compatível, isSetSupported retornará true. O código a seguir mostra um exemplo.

if (Office.context.requirements.isSetSupported("WordApi", "1.2")) {
   // Code that uses API members from the WordApi 1.2 requirement set.
} else {
   // Provide diminished experience here.
   // For example, run alternate code when the user's Word is
   // volume-licensed perpetual Word 2016 (which doesn't support WordApi 1.2).
}

Sobre este código, observe:

• O primeiro parâmetro é necessário. É uma cadeia de caracteres que representa o nome do conjunto de requisitos. Para saber mais sobre os conjuntos de requisitos disponíveis, confira Conjuntos de requisitos de Suplemento do Office.
• O segundo parâmetro é opcional. É uma cadeia de caracteres que especifica a versão mínima do conjunto de requisitos que o aplicativo do Office deve dar suporte para que o código dentro da if instrução seja executado (por exemplo, "1.9"). Se você não usar esse parâmetro, a versão "1.1" será assumida.

A tabela a seguir mostra os nomes dos conjuntos de requisitos para os modelos de API específicos do aplicativo.

Veja a seguir um exemplo de como usar o método com um dos conjuntos de requisitos de modelo de API comum.

if (Office.context.requirements.isSetSupported('CustomXmlParts')) {
    // Run code that uses API members from the CustomXmlParts requirement set.
} else {
    // Run alternate code when the user's Office application doesn't support the CustomXmlParts requirement set.
}

Verifique se há suporte à API sem configuração

Quando o suplemento depender de um método que não faz parte de um conjunto de requisitos, chamado de API sem setless, use uma marca de runtime para determinar se o método tem suporte do aplicativo Office, conforme mostrado no exemplo de código a seguir. Para obter uma lista completa dos métodos que não pertencem a um conjunto de requisitos, confira Conjuntos de requisitos de Suplemento do Office.

O exemplo de código a seguir verifica se o aplicativo do Office dá suporte ao document.setSelectedDataAsync.

if (Office.context.document.setSelectedDataAsync) {
    // Run code that uses `document.setSelectedDataAsync`.
}

Confira também

• Disponibilidade dos conjuntos de requisitos do Office
• Especificar hosts do Office e requisitos de API com o manifesto unificado
• Especificar hosts do Office e requisitos de API com o manifesto somente do suplemento