item (conjunto de requisitos de la versión preliminar del buzón)
Office.context.mailbox.item
item se usa para acceder al mensaje, la convocatoria de reunión o la cita seleccionados actualmente. Puede determinar el tipo del elemento mediante la itemType propiedad .
Requisitos
| Requirement | Valor |
|---|---|
| Versión del conjunto de requisitos mínimos del buzón | 1.1 |
| Nivel de permisos mínimo | restringido |
| Modo de Outlook válido | Organizador de citas, Asistente de cita, Redacción de mensajes o Lectura de mensajes |
Importante
Android e iOS: hay limitaciones sobre cuándo se activan los complementos y qué API están disponibles. Para obtener más información, consulte Agregar compatibilidad móvil a un complemento de Outlook.
Propiedades
Métodos
| Método | Mínimo nivel de permisos |
Detalles por modo | Mínimo conjunto de requisitos |
|---|---|---|---|
| addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | elemento de lectura y escritura | Organizador de citas | 1.1 |
| Redactar mensaje | 1.1 | ||
| addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) | elemento de lectura y escritura | Organizador de citas | 1.8 |
| Redactar mensaje | 1.8 | ||
| addHandlerAsync(eventType, handler, [options], [callback]) | leer elemento | Organizador de citas | 1.7 |
| Asistente de cita | 1.7 | ||
| Redactar mensaje | 1.7 | ||
| Leer mensaje | 1.7 | ||
| addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | elemento de lectura y escritura | Organizador de citas | 1.1 |
| Redactar mensaje | 1.1 | ||
| close() | restringido | Organizador de citas | 1.3 |
| Redactar mensaje | 1.3 | ||
| closeAsync([options], [callback]) | elemento de lectura y escritura | Redactar mensaje | 1.14 |
| disableClientSignatureAsync([options], [callback]) | elemento de lectura y escritura | Organizador de citas | 1.10 |
| Redactar mensaje | 1.10 | ||
| displayReplyAllForm(formData) | leer elemento | Asistente de cita | 1.1 |
| Leer mensaje | 1.1 | ||
| displayReplyAllFormAsync(formData, [options], [callback]) | leer elemento | Asistente de cita | 1.9 |
| Leer mensaje | 1.9 | ||
| displayReplyForm(formData) | leer elemento | Asistente de cita | 1.1 |
| Leer mensaje | 1.1 | ||
| displayReplyFormAsync(formData, [options], [callback]) | leer elemento | Asistente de cita | 1.9 |
| Leer mensaje | 1.9 | ||
| getAllInternetHeadersAsync([options], [callback]) | leer elemento | Leer mensaje | 1.8 |
| getAsFileAsync([options], callback) | leer elemento | Leer mensaje | 1.14 |
| getAttachmentContentAsync(attachmentId, [options], [callback]) | leer elemento | Organizador de citas | 1.8 |
| Asistente de cita | 1.8 | ||
| Redactar mensaje | 1.8 | ||
| Leer mensaje | 1.8 | ||
| getAttachmentsAsync([options], [callback]) | leer elemento | Organizador de citas | 1.8 |
| Redactar mensaje | 1.8 | ||
| getComposeTypeAsync([options], callback) | leer elemento | Redactar mensaje | 1.10 |
| getConversationIndexAsync([options], callback) | leer elemento | Redactar mensaje | 1.14 |
| getEntities() (en desuso) | leer elemento | Asistente de cita | 1.1 |
| Leer mensaje | 1.1 | ||
| getEntitiesByType(entityType) (en desuso) | restringido | Asistente de cita | 1.1 |
| Leer mensaje | 1.1 | ||
| getFilteredEntitiesByName(name) (en desuso) | leer elemento | Asistente de cita | 1.1 |
| Leer mensaje | 1.1 | ||
| getInitializationContextAsync([options], [callback]) | leer elemento | Organizador de citas | 1.8 |
| Asistente de cita | 1.8 | ||
| Redactar mensaje | 1.8 | ||
| Leer mensaje | 1.8 | ||
| getItemClassAsync([options], callback) | leer elemento | Redactar mensaje | 1.14 |
| getItemIdAsync([options], callback) | leer elemento | Organizador de citas | 1.8 |
| Redactar mensaje | 1.8 | ||
| getRegExMatches() | leer elemento | Asistente de cita | 1.1 |
| Leer mensaje | 1.1 | ||
| getRegExMatchesByName(name) | leer elemento | Asistente de cita | 1.1 |
| Leer mensaje | 1.1 | ||
| getSelectedDataAsync(coercionType, [options], callback) | leer elemento | Organizador de citas | 1.2 |
| Redactar mensaje | 1.2 | ||
| getSelectedEntities() (en desuso) | leer elemento | Asistente de cita | 1.6 |
| Leer mensaje | 1.6 | ||
| getSelectedRegExMatches() | leer elemento | Asistente de cita | 1.6 |
| Leer mensaje | 1.6 | ||
| getSharedPropertiesAsync([options], callback) | leer elemento | Organizador de citas | 1.8 |
| Asistente de cita | 1.8 | ||
| Redactar mensaje | 1.8 | ||
| Leer mensaje | 1.8 | ||
| isClientSignatureEnabledAsync([options], callback) | leer elemento | Organizador de citas | 1.10 |
| Redactar mensaje | 1.10 | ||
| loadCustomPropertiesAsync(callback, [userContext]) | leer elemento | Organizador de citas | 1.1 |
| Asistente de cita | 1.1 | ||
| Redactar mensaje | 1.1 | ||
| Leer mensaje | 1.1 | ||
| removeAttachmentAsync(attachmentId, [options], [callback]) | elemento de lectura y escritura | Organizador de citas | 1.1 |
| Redactar mensaje | 1.1 | ||
| removeHandlerAsync(eventType, [options], [callback]) | leer elemento | Organizador de citas | 1.7 |
| Asistente de cita | 1.7 | ||
| Redactar mensaje | 1.7 | ||
| Leer mensaje | 1.7 | ||
| saveAsync([options], callback) | elemento de lectura y escritura | Organizador de citas | 1.3 |
| Redactar mensaje | 1.3 | ||
| setSelectedDataAsync(data, [options], callback) | elemento de lectura y escritura | Organizador de citas | 1.2 |
| Redactar mensaje | 1.2 |
Eventos
Puede suscribirse y cancelar la suscripción a los siguientes eventos mediante addHandlerAsync y removeHandlerAsync respectivamente.
| Evento | Descripción | Mínimo conjunto de requisitos |
|---|---|---|
AppointmentTimeChanged |
La fecha o hora de la cita o serie seleccionada ha cambiado. Solo está disponible con la implementación del panel de tareas. | 1.7 |
AttachmentsChanged |
Se ha agregado o quitado datos adjuntos del elemento. Solo está disponible con la implementación del panel de tareas. | 1.8 |
EnhancedLocationsChanged |
La ubicación de la cita seleccionada ha cambiado. Solo está disponible con la implementación del panel de tareas. | 1.8 |
InfobarClicked |
Se ha seleccionado una acción de un mensaje de notificación. Solo está disponible con la implementación del panel de tareas. | 1.10 |
RecipientsChanged |
La lista de destinatarios del elemento seleccionado o la ubicación de la cita ha cambiado. Solo está disponible con la implementación del panel de tareas. | 1.7 |
RecurrenceChanged |
El patrón de periodicidad de la serie seleccionada ha cambiado. Solo está disponible con la implementación del panel de tareas. | 1.7 |
SensitivityLabelChanged |
La etiqueta de confidencialidad de un mensaje o cita en modo de redacción ha cambiado. Solo está disponible con la implementación del panel de tareas. | 1.13 |
SpamReporting |
Se ha notificado un mensaje no solicitado en Outlook. Solo está disponible con un comando de función. | 1.14 |
Ejemplo
En el siguiente ejemplo de código de JavaScript, se muestra cómo tener acceso a la propiedad subject del elemento actual en Outlook.
// The initialize function is required for all apps.
Office.initialize = function () {
// Checks for the DOM to load using the jQuery ready method.
$(document).ready(function () {
// After the DOM is loaded, app-specific code can run.
const item = Office.context.mailbox.item;
const subject = item.subject;
// Continue with processing the subject of the current item,
// which can be a message or appointment.
});
};
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.