Tipo de recurso outlookCategoryoutlookCategory resource type

Importante

Las API de /beta la versión de Microsoft Graph están sujetas a cambios.APIs under the /beta version in Microsoft Graph are subject to change. No se admite el uso de estas API en aplicaciones de producción.Use of these APIs in production applications is not supported.

Representa una categoría en la que un usuario puede agrupar elementos de Outlook tales como mensajes y eventos.Represents a category by which a user can group Outlook items such as messages and events. En Outlook, el usuario define las categorías de una lista maestra y puede aplicar una o varias de estas categorías definidas por el usuario a un elemento.In Outlook, the user defines categories in a master list, and can apply one or more of these user-defined categories to an item.

Con la API de REST, puede crear y definir categorías en la lista principal de categorías de un usuario.Using the REST API, you can create and define categories in the master list of categories for a user. También puede obtener esta lista principal de categorías, obtener una categoría específica, actualizar el color asociado a una categoría o eliminar una categoría.You can also get this master list of categories, get a specific category, update the color associated with a category, or delete a category. Puede aplicar una categoría a un elemento asignando la propiedad displayName de la categoría a la colección categories del elemento.You can apply a category to an item by assigning the displayName property of the category to the categories collection of the item. Entre los recursos que se pueden asignar categorías se incluyen contacto, evento, mensaje, outlooktask (y publicación.Resources that can be assigned categories include contact, event, message, outlookTask, and post.

A cada categoría se le asignan atributos con dos propiedades: displayName y color.Each category is attributed by 2 properties: displayName and color. El valor de displayName debe ser único en la lista principal de un usuario.The displayName value must be unique in a user's master list. Pero el valor de color no tiene que ser único; puede asignarse el mismo color a varias categorías de la lista principal.The color however does not have to be unique; multiple categories in the master list can be mapped to the same color. Puede asignar hasta 25 colores distintos a las categorías de la lista principal de un usuario.You can map up to 25 different colors to categories in a user's master list.

PropiedadesProperties

PropiedadProperty TipoType DescripciónDescription
displayNamedisplayName CadenaString Nombre único que identifica una categoría en el buzón del usuario.A unique name that identifies a category in the user's mailbox. Después de crear una categoría, no puede cambiarse el nombre.After a category is created, the name cannot be changed. Solo lectura.Read-only.
colorcolor StringString Constante de color preestablecida que caracteriza a una categoría y a la que se asigna uno de los 25 colores predefinidos.A pre-set color constant that characterizes a category, and that is mapped to one of 25 predefined colors. Vea la nota siguiente.See the note below.

Nota Los posibles valores de color son constantes preestablecidas tales como None, preset0 y preset1.Note The possible values for color are pre-set constants such as None, preset0 and preset1. A cada constante preestablecida se le asigna asimismo un color; el color real depende del cliente de Outlook en que se muestran las categorías.Each pre-set constant is further mapped to a color; the actual color is dependent on the Outlook client that the categories are being displayed in. La siguiente tabla muestra los colores asignados a cada constante preestablecida en Outlook (cliente de escritorio).The following table shows the colors mapped to each pre-set constant for Outlook (desktop client).

Constante preestablecidaPre-set constant Color al que se asigna en OutlookColor mapped to in Outlook
NingunoNone Ningún color asignadoNo color mapped
Preset0Preset0 RojoRed
Preset1Preset1 NaranjaOrange
Preset2Preset2 MarrónBrown
Preset3Preset3 AmarilloYellow
Preset4Preset4 VerdeGreen
Preset5Preset5 Verde azuladoTeal
Preset6Preset6 OlivaOlive
Preset7Preset7 AzulBlue
Preset8Preset8 PúrpuraPurple
Preset9Preset9 ArándanoCranberry
Preset10Preset10 AceroSteel
Preset11Preset11 Acero oscuroDarkSteel
Preset12Preset12 GrisGray
Preset13Preset13 Gris oscuroDarkGray
Preset14Preset14 NegroBlack
Preset15Preset15 Rojo oscuroDarkRed
Preset16Preset16 Anaranjado oscuroDarkOrange
Preset17Preset17 Marrón oscuroDarkBrown
Preset18Preset18 Amarillo oscuroDarkYellow
Preset19Preset19 Verde oscuroDarkGreen
Preset20Preset20 Verde azulado oscuroDarkTeal
Preset21Preset21 Oliva oscuroDarkOlive
Preset22Preset22 Azul oscuroDarkBlue
Preset23Preset23 Púrpura oscuroDarkPurple
Preset24Preset24 Arándano oscuroDarkCranberry

Representación JSONJSON representation

Aquí tiene una representación JSON del recurso.Here is a JSON representation of the resource.

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

MétodosMethods

MétodoMethod Tipo de valor devueltoReturn Type DescripciónDescription
Enumerar categoríasList categories Colección outlookCategoryoutlookCategory collection Obtener todas las categorías que han sido definidas por el usuario.Get all the categories that have been defined for the user.
Obtener categoríaGet category outlookCategoryoutlookCategory Obtener las propiedades y relaciones del objeto outlookCategory especificado.Get the properties and relationships of the specified outlookCategory object.
CrearCreate outlookCategoryoutlookCategory Crear un objeto outlookCategory en la lista principal de categorías del usuario.Create an outlookCategory object in the user's master list of categories.
ActualizarUpdate outlookCategoryoutlookCategory Actualizar la propiedad modificable color del objeto outlookCategory especificado.Update the writable property, color, of the specified outlookCategory object.
DeleteDelete NingunoNone Eliminar el objeto outlookCategory especificado.Delete the specified outlookCategory object.