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 la versión 1.5
El conjunto de requisitos del buzón 1.5 incluye todas las características del conjunto de requisitos 1.4. Se han agregado las siguientes características.
- Se agregó la compatibilidad con los paneles de tareas anclables.
- Se agregó la compatibilidad para llamar a las API de REST.
Importante
Los puntos de conexión de Outlook REST v2.0 y beta están en desuso. En su lugar, use la API REST de Microsoft Graph .
- Se ha agregado compatibilidad para marcar los datos adjuntos como alineados.
- Se ha agregado compatibilidad para cerrar un panel de tareas o un cuadro de diálogo mediante programación.
- Se ha agregado compatibilidad con la propiedad Office.context.diagnostics y sus objetos relacionados.
- Se ha agregado un evento para determinar cuándo se selecciona un elemento de correo de Outlook para verlo mientras el panel de tareas del complemento está anclado.
Lista de API
En la tabla siguiente se enumeran las API introducidas en el conjunto de requisitos de buzón 1.5. Para ver la documentación de referencia de API de todas las API admitidas por el conjunto de requisitos de buzón 1.5 o anteriores, consulte API de Outlook.
| Clase | Campos | Descripción |
|---|---|---|
| DragAndDropEventArgs | dragAndDropEventData | Obtiene los detalles sobre la posición del puntero del mouse dentro del panel de tareas de un complemento y los mensajes o archivos adjuntos que se arrastran y colocan en el panel de tareas. |
| type | Obtiene el tipo del evento. | |
| DragoverEventData | pageX | Obtiene la coordenada x del puntero del mouse que representa la posición horizontal en píxeles. |
| pageY | Obtiene la coordenada y del puntero del mouse que representa la posición vertical en píxeles. | |
| taskPaneX | Obtiene la coordenada x del puntero del mouse que representa la posición horizontal en píxeles. | |
| taskPaneY | Obtiene la coordenada y del puntero del mouse que representa la posición vertical en píxeles. | |
| type | Obtiene el tipo de evento de arrastrar y soltar. | |
| DropEventData | transferencia de datos | Obtiene los mensajes o archivos adjuntos que se arrastran y sueltan en el panel de tareas de un complemento. |
| pageX | Obtiene la coordenada x del puntero del mouse que representa la posición horizontal en píxeles. | |
| pageY | Obtiene la coordenada y del puntero del mouse que representa la posición vertical en píxeles. | |
| taskPaneX | Obtiene la coordenada x del puntero del mouse que representa la posición horizontal en píxeles. | |
| taskPaneY | Obtiene la coordenada y del puntero del mouse que representa la posición vertical en píxeles. | |
| type | Obtiene el tipo de evento de arrastrar y soltar. | |
| DroppedItemDetails | contenido de archivos | Obtiene el contenido del archivo que se está arrastrando y colocando. |
| name | Obtiene el nombre del archivo que se está arrastrando y colocando. | |
| type | Obtiene el tipo de archivo que se está arrastrando y colocando. | |
| DroppedItems | archivos desconocidos | Obtiene una matriz de los mensajes o archivos adjuntos que se arrastran y colocan en el panel de tareas de un complemento. |
| Buzón | addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega un controlador de eventos para un evento admitido. |
| addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega un controlador de eventos para un evento admitido. | |
| getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene una cadena que contiene un token que se usa para llamar a las API de REST o a los servicios Web Exchange (EWS). | |
| removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Elimina el controlador de eventos de un tpo de evento admitido. | |
| removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Elimina el controlador de eventos de un tpo de evento admitido. | |
| restUrl | Obtiene la URL del punto de conexión REST para esta cuenta de correo electrónico. |
Eventos
En la tabla siguiente se enumeran los eventos introducidos en el conjunto de requisitos 1.5. 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 |
|---|---|---|
| Elemento cambiado | Se selecciona un elemento diferente de Outlook para verlo mientras el panel de tareas del complemento está anclado. | Mailbox |