Office.MasterCategories interface

Referência

Pacote:: outlook

Representa a lista principal de categorias na caixa de correio.

No Outlook, um utilizador pode etiquetar mensagens e compromissos ao utilizar uma categoria para os codificar. O usuário define as categorias em uma lista mestra em sua caixa de correio. Ele pode, em seguida, aplicar uma ou mais categorias a um item.

Importante: em cenários delegados ou partilhados, o delegado pode obter as categorias na lista principal, mas não pode adicionar ou remover categorias.

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

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

Modo Outlook aplicável: Compor ou Ler

Métodos

addAsync(categories, options, callback)	Adiciona categorias à lista principal numa caixa de correio. Cada categoria tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.
addAsync(categories, callback)	Adiciona categorias à lista principal numa caixa de correio. Cada categoria tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.
getAsync(options, callback)	Obtém a lista principal de categorias numa caixa de correio.
getAsync(callback)	Obtém a lista principal de categorias numa caixa de correio.
removeAsync(categories, options, callback)	Remove categorias da lista principal numa caixa de correio.
removeAsync(categories, callback)	Remove categorias da lista principal numa caixa de correio.

Detalhes do método

addAsync(categories, options, callback)

Adiciona categorias à lista principal numa caixa de correio. Cada categoria tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.

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

Parâmetros

categories: Office.CategoryDetails[]

As categorias a adicionar à lista principal na caixa de correio.

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: caixa de correio de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

Erros:

DuplicateCategory : uma das categorias fornecidas já se encontra na lista de categorias principais.
PermissionDenied : o utilizador não tem permissão para efetuar esta ação.

Exemplos

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

const masterCategoriesToAdd = [
  {
    displayName: "TestCategory",
    color: Office.MailboxEnums.CategoryColor.Preset0
  }
];

Office.context.mailbox.masterCategories.addAsync(masterCategoriesToAdd, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully added categories to master list");
  } else {
    console.log("masterCategories.addAsync call failed with error: " + asyncResult.error.message);
  }
});

addAsync(categories, callback)

Adiciona categorias à lista principal numa caixa de correio. Cada categoria tem de ter um nome exclusivo, mas várias categorias podem utilizar a mesma cor.

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

Parâmetros

categories: Office.CategoryDetails[]

As categorias a adicionar à lista principal na caixa de correio.

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: caixa de correio de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

Erros:

DuplicateCategory : uma das categorias fornecidas já se encontra na lista de categorias principais.
PermissionDenied : o utilizador não tem permissão para efetuar esta ação.

getAsync(options, callback)

Obtém a lista principal de categorias numa caixa de correio.

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 adiçã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: caixa de correio de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

getAsync(callback)

Obtém a lista principal de categorias numa caixa de correio.

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

Parâmetros

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.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.8 ]

Nível mínimo de permissão: caixa de correio 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-master-categories.yaml

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Master categories:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories in the master list.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

removeAsync(categories, options, callback)

Remove categorias da lista principal numa caixa de correio.

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

Parâmetros

categories: string[]

As categorias a serem removidas da lista principal na caixa de correio.

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: caixa de correio de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

Erros:

PermissionDenied : o utilizador não tem permissão para efetuar esta ação.

Exemplos

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

const masterCategoriesToRemove = ["TestCategory"];

Office.context.mailbox.masterCategories.removeAsync(masterCategoriesToRemove, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Successfully removed categories from master list");
  } else {
    console.log("masterCategories.removeAsync call failed with error: " + asyncResult.error.message);
  }
});

removeAsync(categories, callback)

Remove categorias da lista principal numa caixa de correio.

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

Parâmetros

categories: string[]

As categorias a serem removidas da lista principal na caixa de correio.

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: caixa de correio de leitura/escrita

Modo Outlook aplicável: Compor ou Ler

Erros:

PermissionDenied : o utilizador não tem permissão para efetuar esta ação.

Compartilhar via

Office.MasterCategories 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