Office.Categories interface

Adiciona categorias a um item. Cada categoria tem de estar na lista principal de categorias nessa caixa de correio, pelo que tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.

Importante: no Outlook na Web e no novo Outlook no Windows, não pode utilizar a API para gerir categorias aplicadas a uma mensagem ou item de compromisso no modo de Composição.

addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

Erros:

• InvalidCategory : foram fornecidas categorias inválidas.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Adiciona categorias a um item. Cada categoria tem de estar na lista principal de categorias nessa caixa de correio, pelo que tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.

Importante: no Outlook na Web e no novo Outlook no Windows, não pode utilizar a API para gerir categorias aplicadas a uma mensagem ou item de compromisso no modo de Composição.

addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

Erros:

• InvalidCategory : foram fornecidas categorias inválidas.

Obtém as categorias de um item.

Importante:

• Se não existirem categorias no item null ou se uma matriz vazia for devolvida consoante a versão do Outlook, certifique-se de que processa ambos os casos.

• No Outlook na Web e no novo Outlook no Windows, não pode utilizar a API para gerir categorias aplicadas a uma mensagem no modo Compor.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compor ou Ler

Obtém as categorias de um item.

Importante:

• Se não existirem categorias no item null ou se uma matriz vazia for devolvida consoante a versão do Outlook, certifique-se de que processa ambos os casos.

• No Outlook na Web e no novo Outlook no Windows, não pode utilizar a API para gerir categorias aplicadas a uma mensagem no modo Compor.

getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: ler item

Modo Outlook aplicável: Compor ou Ler

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Remove categorias de um item.

Importante: no Outlook na Web e no novo Outlook no Windows, não pode utilizar a API para gerir categorias aplicadas a uma mensagem no modo Compor.

removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

Remove categorias de um item.

Importante: no Outlook na Web e no novo Outlook no Windows, não pode utilizar a API para gerir categorias aplicadas a uma mensagem no modo Compor.

removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Compor ou Ler