Verificar a disponibilidade da API no runtime

Se o seu suplemento utilizar uma funcionalidade de extensibilidade específica para algumas das suas funcionalidades, mas tiver outras funcionalidades úteis que não exijam a funcionalidade de extensibilidade, deve estruturar o suplemento para que seja instalável nas combinações de plataformas e versões do Office que não suportam a funcionalidade de extensibilidade. Pode proporcionar uma experiência valiosa, embora diminuída, nessas combinações.

Quando a diferença nas duas experiências consiste inteiramente em diferenças nas APIs da Biblioteca JavaScript do Office que são chamadas e não em quaisquer funcionalidades configuradas no manifesto, teste no runtime para descobrir se o cliente do Office do utilizador suporta um conjunto de requisitos de API. Também pode testar no runtime se as APIs que não estão num conjunto são suportadas.

Verificar se existe suporte para o conjunto de requisitos

O método isSetSupported é utilizado para marcar para o suporte do conjunto de requisitos. Transmita o nome do conjunto de requisitos e a versão mínima como parâmetros. Se o conjunto de requisitos for suportado, isSetSupported devolve 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:

• É necessário o primeiro parâmetro. É uma cadeia 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 que especifica a versão do conjunto de requisitos mínimo que a aplicação do Office tem de suportar para que o código na if instrução seja executado (por exemplo, "1,9"). Se não for utilizada, é assumida a versão "1.1".

A tabela seguinte mostra os nomes dos conjuntos de requisitos para os modelos de API específicos da aplicação.

Segue-se um exemplo de utilização do método com um dos conjuntos de requisitos do 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.
}

Verificar se existe suporte de API sem definições

Quando o seu suplemento depende de um método que não faz parte de um conjunto de requisitos, denominado API sem definições, utilize um runtime marcar para determinar se o método é suportado pela aplicação do Office, conforme mostrado no exemplo de código seguinte. 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 seguinte exemplo de código verifica se a aplicação do Office suporta document.setSelectedDataAsync.

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

Confira também

• Disponibilidade dos conjuntos de requisitos do Office
• Especifique os anfitriões do Office e os requisitos de API com o manifesto unificado
• Especifique os anfitriões do Office e os requisitos de API com o manifesto apenas do suplemento