Office.Categories interface

Referência

Pacote:: outlook

Representa as categorias num item.

No Outlook, um utilizador pode etiquetar mensagens e compromissos ao utilizar uma categoria para os codificar. O utilizador define categorias numa lista de master na respetiva caixa de correio. Ele pode, em seguida, aplicar uma ou mais categorias a 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 Compose.

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

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

Modo Outlook aplicável: Compose ou Leitura

Métodos

addAsync(categories, options, callback)	Adiciona categorias a um item. Cada categoria tem de estar nas categorias master lista nessa caixa de correio, pelo que tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.
addAsync(categories, callback)	Adiciona categorias a um item. Cada categoria tem de estar nas categorias master lista nessa caixa de correio, pelo que tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.
getAsync(options, callback)	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 Compose.
getAsync(callback)	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 Compose.
removeAsync(categories, options, callback)	Remove categorias de um item.
removeAsync(categories, callback)	Remove categorias de um item.

Detalhes do método

addAsync(categories, options, callback)

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

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

Parâmetros

categories: string[]

As categorias a adicionar ao item.

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

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: Compose ou Leitura

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 Compose.

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);
  }
});

addAsync(categories, callback)

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

Parâmetros

categories: string[]

As categorias a adicionar ao item.

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

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: Compose ou Leitura

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 Compose.

Erros:

InvalidCategory : foram fornecidas categorias inválidas.

getAsync(options, callback)

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 Compose.

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

Parâmetros

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

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

Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a obtenção de categorias falhar, a asyncResult.error propriedade conterá um código de erro.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

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

Modo Outlook aplicável: Compose ou Leitura

getAsync(callback)

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 Compose.

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

Parâmetros

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

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

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

Modo Outlook aplicável: Compose ou Leitura

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);
  }
});

removeAsync(categories, options, callback)

Remove categorias de um item.

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

Parâmetros

categories: string[]

As categorias a serem removidas do item.

options: Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades: asyncContext: os programadores podem fornecer qualquer objeto a que pretendam aceder na função de chamada de retorno.

callback: (asyncResult: Office.AsyncResult<void>) => void

Opcional. Quando o método for concluído, a função transmitida no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult. Se a remoção de categorias falhar, a asyncResult.error propriedade conterá um código de erro.

Retornos

void

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: Compose ou Leitura

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 Compose.

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);
  }
});

removeAsync(categories, callback)

Remove categorias de um item.

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

Parâmetros

categories: string[]

As categorias a serem removidas do item.

callback: (asyncResult: Office.AsyncResult<void>) => void

Retornos

void

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: Compose ou Leitura

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 Compose.

Compartilhar via

Office.Categories interface

Comentários

Métodos

Detalhes do método

addAsync(categories, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

addAsync(categories, callback)

Parâmetros

Retornos

Comentários

getAsync(options, callback)

Parâmetros

Retornos

Comentários

getAsync(callback)

Parâmetros

Retornos

Comentários

Exemplos

removeAsync(categories, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

removeAsync(categories, callback)

Parâmetros

Retornos

Comentários

Recursos adicionais