Tipo de recurso outlookCategory

  • Artigo

Namespace: microsoft.graph

Representa uma categoria pela qual um usuário pode agrupar itens do Outlook como mensagens e eventos. O usuário define categorias em uma lista mestra e pode aplicar uma ou mais das seguintes categorias definidas pelo usuário a um item.

Usando a API REST, é possível criar e definir categorias na lista mestra de categorias para um usuário. Também é possível acessar essa lista mestra de categorias, obter uma categoria específica, atualizar a cor associada a uma categoria ou excluir uma categoria. É possível aplicar uma categoria a um item atribuindo a propriedade displayName da categoria à coleção categories do item. Os recursos que podem ser atribuídos às categorias incluem contato, evento, mensagem, postagem e todoTask.

Cada categoria é atribuída por duas propriedades: displayName e color. O valor displayName deve ser exclusivo na lista mestra de um usuário. No entanto, o valor color não precisa ser exclusivo. Várias categorias na lista mestra podem ser mapeadas para a mesma cor. É possível mapear até 25 cores diferentes para as categorias na lista mestra a um usuário.

Métodos

Método Tipo de retorno Descrição
Listar categorias Coleção outlookCategory Obtém todas as categorias que foram definidas para o usuário.
Obter categoria outlookCategory Obtenha as propriedades e as relações do objeto outlookCategory especificado.
Criar outlookCategory Cria um objeto outlookCategory na lista mestra de categorias do usuário.
Atualizar outlookCategory Atualize a propriedade gravável, color, do objeto outlookCategory especificado.
Excluir Nenhum Exclua o objeto outlookCategory especificado.

Propriedades

Propriedade Tipo Descrição
color categoryColor Uma constante de cor predefinida que caracteriza uma categoria e que é mapeada para uma das 25 cores predefinidas. Para obter mais detalhes, confira a nota a seguir.
displayName Cadeia de caracteres Um nome exclusivo que identifica uma categoria na caixa de correio do usuário. Após a criação de uma categoria, o nome não poderá ser alterado. Somente leitura.

Observação Os valores possíveis para color são constantes predefinidas como None, preset0 e preset1. Cada constante predefinida é mapeada para uma cor. A cor real depende do cliente do Outlook em que as categorias estão sendo exibidas. A tabela a seguir mostra as cores mapeadas para cada constante predefinida do Outlook (cliente da área de trabalho).

Constante predefinida Cor mapeada para no Outlook
Nenhum Nenhuma cor mapeada
Preset0 Vermelho
Preset1 Laranja
Preset2 Marrom
Preset3 Amarelo
Preset4 Verde
Preset5 Azul-petróleo
Preset6 Verde-oliva
Preset7 Azul
Preset8 Roxo
Preset9 Cranberry
Preset10 Steel
Preset11 DarkSteel
Preset12 Cinza
Preset13 DarkGray
Preset14 Preto
Preset15 DarkRed
Preset16 DarkOrange
Preset17 DarkBrown
Preset18 DarkYellow
Preset19 DarkGreen
Preset20 DarkTeal
Preset21 DarkOlive
Preset22 DarkBlue
Preset23 DarkPurple
Preset24 DarkCranberry

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "color": "String",
  "displayName": "String"
}