Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
El subconjunto de API de complementos de Outlook de la API de JavaScript de Office incluye objetos, métodos, propiedades y eventos que puede usar en un complemento de Outlook.
Nota:
Esta documentación es para un conjunto de requisitos que no sea el último conjunto de requisitos.
Novedades de 1.13
El conjunto de requisitos de buzón 1.13 incluye todas las características del conjunto de requisitos 1.12. Se han agregado las siguientes características.
- Se ha agregado soporte para activar un complemento sin el panel de lectura habilitado o sin un mensaje seleccionado.
- Se ha agregado compatibilidad para administrar los datos de entrega y la hora de un mensaje.
- Se han agregado nuevos eventos para la activación basada en eventos.
- Se ha añadido la característica de selección múltiple de artículos.
- Se ha agregado la característica de anteponer al enviar.
- Se ha agregado la característica de etiqueta de confidencialidad.
- Se ha agregado compatibilidad con escenarios de buzón compartido.
Lista de API
En la tabla siguiente se enumeran las API introducidas en el conjunto de requisitos de buzón 1.13. Para ver la documentación de referencia de API para todas las API admitidas por el conjunto de requisitos de buzón 1.13 o versiones anteriores, consulte API de Outlook.
| Clase | Campos | Descripción |
|---|---|---|
| AppointmentCompose | etiqueta de confidencialidad | Obtiene el objeto para obtener o establecer la etiqueta de confidencialidad de una cita. |
| Cuerpo | prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Antepone HTML o texto sin formato al principio del cuerpo de un mensaje o cita cuando se envía el elemento de correo. |
| prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Antepone HTML o texto sin formato al principio del cuerpo de un mensaje o cita cuando se envía el elemento de correo. | |
| DelayDeliveryTime | getAsync(callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void) | Obtiene la fecha y hora de entrega de un mensaje. |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date | 0>) => void) | Obtiene la fecha y hora de entrega de un mensaje. | |
| setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece la fecha y hora de entrega de un mensaje. | |
| setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece la fecha y hora de entrega de un mensaje. | |
| Buzón | getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void) | Obtiene los mensajes seleccionados actualmente en los que un complemento puede activar y realizar operaciones. |
| getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SelectedItemDetails[]>) => void) | Obtiene los mensajes seleccionados actualmente en los que un complemento puede activar y realizar operaciones. | |
| MessageCompose | delayDeliveryTime | Obtiene o establece la fecha y hora de entrega retrasada de un mensaje. |
| etiqueta de confidencialidad | Obtiene el objeto para obtener o establecer la etiqueta de confidencialidad de un mensaje. | |
| SelectedItemDetails | itemId | El identificador de elemento Servicios Web Exchange (EWS) del mensaje que está seleccionado actualmente. |
| itemMode | El modo de Outlook (Read o Compose) del mensaje que está seleccionado actualmente. |
|
| itemType | El tipo del elemento que está seleccionado actualmente. | |
| subject | Descripción que aparece en el campo Asunto del mensaje que está seleccionado actualmente. | |
| SensitivityLabel | getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene el identificador único (GUID) de la etiqueta de confidencialidad aplicada a un mensaje o cita que se está redactando. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene el identificador único (GUID) de la etiqueta de confidencialidad aplicada a un mensaje o cita que se está redactando. | |
| setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Aplica la etiqueta de confidencialidad especificada al mensaje o cita que se está redactando. | |
| setAsync(sensitivityLabel: string | SensitivityLabelDetails, opciones: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Aplica la etiqueta de confidencialidad especificada al mensaje o cita que se está redactando. | |
| SensitivityLabelChangedEventArgs | type | El tipo de evento que se generó. |
| SensitivityLabelDetails | Niños | Las subetiquetas de la etiqueta de confidencialidad. |
| color | El color de la etiqueta de confidencialidad. | |
| id | El identificador único (GUID) de la etiqueta de confidencialidad. | |
| name | El nombre de la etiqueta de confidencialidad. | |
| información sobre herramientas | La descripción de la etiqueta de confidencialidad. | |
| SensitivityLabelsCatalog | getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void) | Obtiene todas las etiquetas de confidencialidad que están habilitadas en Outlook. |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void) | Obtiene todas las etiquetas de confidencialidad que están habilitadas en Outlook. | |
| getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Comprueba si el catálogo de etiquetas de confidencialidad está habilitado en Outlook. | |
| getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) | Comprueba si el catálogo de etiquetas de confidencialidad está habilitado en Outlook. |
Eventos
En la tabla siguiente se enumeran los eventos introducidos en el conjunto de requisitos 1.13. Para obtener una lista de todos los eventos admitidos que se pueden controlar con los addHandlerAsync métodos and removeHandlerAsync , vea Office.EventType.
| Evento | Descripción | Object |
|---|---|---|
| SelectedItemsChanged | Uno o varios mensajes están seleccionados o no seleccionados. | Mailbox |
| SensitivityLabelChanged | Se cambia la etiqueta de confidencialidad de un mensaje o una cita. | Elemento |
Nota:
Para los eventos compatibles con un complemento de activación basada en eventos, vea Activar complementos con eventos.
Actualizaciones de manifiestos
En la tabla siguiente se enumeran las actualizaciones de manifiestos introducidas en el conjunto de requisitos de buzón 1.13. Para obtener más información sobre los tipos de manifiestos de complementos de Office, vea Manifiesto de complementos de Office.
| Característica | Manifiesto unificado para Microsoft 365 | Manifiesto de solo complemento | Descripción |
|---|---|---|---|
| Sin contexto de elemento | "extensions.runtimes.actions.supportsNoItemContext" |
SupportsNoItemContext | Permite que los complementos del panel de tareas se activen sin que el panel de lectura esté habilitado o sin que se haya seleccionado un mensaje. |
| Compatibilidad con buzones compartidos |
"authorization.permissions.resourceSpecific.name" Establecer en "Mailbox.SharedFolder" |
SupportsSharedFolders | Define si el complemento está disponible en escenarios de buzón compartido. |