Partilhar via


Conjuntos de requisitos da API JavaScript do OneNote

Os conjuntos de requisitos são grupos nomeados de membros da API. Os Suplementos do Office usam conjuntos de requisitos especificados no manifesto ou usam uma verificação de tempo de execução para determinar se um aplicativo do Office oferece suporte para as APIs necessárias para um suplemento. Para obter mais informações, consulte Versões do Office e conjuntos de requisitos.

A tabela seguinte lista os conjuntos de requisitos do OneNote, as aplicações cliente do Office suportadas e as versões ou compilações mínimas para essas aplicações, quando aplicável.

Conjunto de requisitos Office na Web
OneNoteApi 1.1 Com suporte

OneNote JavaScript API 1.1

A OneNote JavaScript API 1.1 é a primeira versão da API. Para obter mais detalhes sobre a API, confira o artigo Visão geral da programação da API JavaScript do OneNote.

Verificação do suporte a requisitos de tempo de execução

Durante o tempo de execução, os suplementos podem verificar se um determinado aplicativo do Office oferece suporte a um conjunto de requisitos de API, realizando a seguinte verificação:

if (Office.context.requirements.isSetSupported('OneNoteApi', '1.1')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

Verificação de suporte a requisitos com base em manifesto

Use o Requirements elemento no manifesto do suplemento para especificar conjuntos de requisitos ou membros de API cruciais que o seu suplemento precisa usar. Se o aplicativo do Office ou a plataforma não der suporte ao conjunto de requisitos ou membros da API especificados no. elementoRequirements, o suplemento não será executado no aplicativo ou na plataforma e não será exibido em Meus Suplementos.

O exemplo de código a seguir mostra um suplemento que é carregado em todos os aplicativos do cliente Office que oferecem suporte ao conjunto de requisitos OneNoteApi, versão 1.1.

<Requirements>
   <Sets DefaultMinVersion="1.1">
      <Set Name="OneNoteApi" MinVersion="1.1"/>
   </Sets>
</Requirements>

Conjuntos de requisitos da API comum do Office

Para saber mais sobre conjuntos de requisitos comuns da API, confira Conjuntos de requisitos comuns da API do Office.

Confira também