item (ensemble de conditions requises pour la préversion de boîte aux lettres)
Office.context.mailbox.item
item
est utilisé pour accéder au message, à la demande de réunion ou au rendez-vous actuellement sélectionné. Vous pouvez déterminer le type de l’élément à l’aide de la itemType
propriété .
Configuration requise
Conditions requises | Valeur |
---|---|
Version de l’ensemble minimal de conditions de boîte aux lettres | 1.1 |
Niveau d’autorisation minimal | restreint |
Mode Outlook applicable | Organisateur de rendez-vous, Participant au rendez-vous, Message Compose ou Message lu |
Importante
Android et iOS : Il existe des limitations quant à l’activation des compléments et aux API disponibles. Pour plus d’informations, reportez-vous à Ajouter une prise en charge mobile à un complément Outlook.
Propriétés
Méthodes
Méthode | Minimum niveau d’autorisation |
Détails par mode | Minimum Ensemble de conditions requises |
---|---|---|---|
addFileAttachmentAsync(uri, attachmentName, [options], [callback]) | élément en lecture/écriture | Organisateur de rendez-vous |
1.1 (Windows classique, Mac) 1.8 (Web, nouveau Windows) |
Composer un message |
1.1 (Windows classique, Mac) 1.8 (Web, nouveau Windows) |
||
addFileAttachmentFromBase64Async(base64File, attachmentName, [options], [callback]) | élément en lecture/écriture | Organisateur de rendez-vous | 1.8 |
Composer un message | 1.8 | ||
addHandlerAsync(eventType, handler, [options], [callback]) | lire l’élément | Organisateur de rendez-vous | 1.7 |
Participant au rendez-vous | 1.7 | ||
Composer un message | 1.7 | ||
Message lu | 1.7 | ||
addItemAttachmentAsync(itemId, attachmentName, [options], [callback]) | élément en lecture/écriture | Organisateur de rendez-vous | 1.1 |
Composer un message | 1.1 | ||
close() | restreint | Organisateur de rendez-vous | 1.3 |
Composer un message | 1.3 | ||
closeAsync([options], [callback]) | élément en lecture/écriture | Composer un message | 11.4 |
disableClientSignatureAsync([options], [callback]) | élément en lecture/écriture | Organisateur de rendez-vous | 1.10 |
Composer un message | 1.10 | ||
displayReplyAllForm(formData) | lire l’élément | Participant au rendez-vous | 1.1 |
Message lu | 1.1 | ||
displayReplyAllFormAsync(formData, [options], [callback]) | lire l’élément | Participant au rendez-vous | 1.9 |
Message lu | 1.9 | ||
displayReplyForm(formData) | lire l’élément | Participant au rendez-vous | 1.1 |
Message lu | 1.1 | ||
displayReplyFormAsync(formData, [options], [callback]) | lire l’élément | Participant au rendez-vous | 1.9 |
Message lu | 1.9 | ||
getAllInternetHeadersAsync([options], [callback]) | lire l’élément | Message lu | 1.8 |
getAsFileAsync([options], callback) | lire l’élément | Message lu | 11.4 |
getAttachmentContentAsync(attachmentId, [options], [callback]) | lire l’élément | Organisateur de rendez-vous | 1.8 |
Participant au rendez-vous | 1.8 | ||
Composer un message | 1.8 | ||
Message lu | 1.8 | ||
getAttachmentsAsync([options], [callback]) | lire l’élément | Organisateur de rendez-vous | 1.8 |
Composer un message | 1.8 | ||
getComposeTypeAsync([options], callback) | lire l’élément | Composer un message | 1.10 |
getConversationIndexAsync([options], callback) | lire l’élément | Composer un message | 11.4 |
getEntities() (déconseillé) | lire l’élément | Participant au rendez-vous | 1.1 |
Message lu | 1.1 | ||
getEntitiesByType(entityType) (déconseillé) | restreint | Participant au rendez-vous | 1.1 |
Message lu | 1.1 | ||
getFilteredEntitiesByName(name) (déconseillé) | lire l’élément | Participant au rendez-vous | 1.1 |
Message lu | 1.1 | ||
getInitializationContextAsync([options], [callback]) | lire l’élément | Organisateur de rendez-vous | 1.8 |
Participant au rendez-vous | 1.8 | ||
Composer un message | 1.8 | ||
Message lu | 1.8 | ||
getItemClassAsync([options], callback) | lire l’élément | Composer un message | 11.4 |
getItemIdAsync([options], callback) | lire l’élément | Organisateur de rendez-vous | 1.8 |
Composer un message | 1.8 | ||
getRegExMatches() | lire l’élément | Participant au rendez-vous | 1.1 |
Message lu | 1.1 | ||
getRegExMatchesByName(name) | lire l’élément | Participant au rendez-vous | 1.1 |
Message lu | 1.1 | ||
getSelectedDataAsync(coercionType, [options], callback) | lire l’élément | Organisateur de rendez-vous | 1.2 |
Composer un message | 1.2 | ||
getSelectedEntities() (déconseillé) | lire l’élément | Participant au rendez-vous | 1.6 |
Message lu | 1.6 | ||
getSelectedRegExMatches() | lire l’élément | Participant au rendez-vous | 1.6 |
Message lu | 1.6 | ||
getSharedPropertiesAsync([options], callback) | lire l’élément | Organisateur de rendez-vous |
1.8 (prise en charge des dossiers partagés) 1.13 (prise en charge des boîtes aux lettres partagées) |
Participant au rendez-vous |
1.8 (prise en charge des dossiers partagés) 1.13 (prise en charge des boîtes aux lettres partagées) |
||
Composer un message |
1.8 (prise en charge des dossiers partagés) 1.13 (prise en charge des boîtes aux lettres partagées) |
||
Message lu |
1.8 (prise en charge des dossiers partagés) 1.13 (prise en charge des boîtes aux lettres partagées) |
||
isClientSignatureEnabledAsync([options], callback) | lire l’élément | Organisateur de rendez-vous | 1.10 |
Composer un message | 1.10 | ||
loadCustomPropertiesAsync(callback, [userContext]) | lire l’élément | Organisateur de rendez-vous | 1.1 |
Participant au rendez-vous | 1.1 | ||
Composer un message | 1.1 | ||
Message lu | 1.1 | ||
removeAttachmentAsync(attachmentId, [options], [callback]) | élément en lecture/écriture | Organisateur de rendez-vous | 1.1 |
Composer un message | 1.1 | ||
removeHandlerAsync(eventType, [options], [callback]) | lire l’élément | Organisateur de rendez-vous | 1.7 |
Participant au rendez-vous | 1.7 | ||
Composer un message | 1.7 | ||
Message lu | 1.7 | ||
saveAsync([options], callback) | élément en lecture/écriture | Organisateur de rendez-vous | 1.3 |
Composer un message | 1.3 | ||
setSelectedDataAsync(data, [options], callback) | élément en lecture/écriture | Organisateur de rendez-vous | 1.2 |
Composer un message | 1.2 |
Événements
Vous pouvez vous abonner et vous désabonner des événements suivants à l’aide addHandlerAsync
de et removeHandlerAsync
respectivement.
Événement | Description | Minimum Ensemble de conditions requises |
---|---|---|
AppointmentTimeChanged |
La date ou l’heure de la série ou du rendez-vous sélectionné a été modifiée. Disponible uniquement avec l’implémentation du volet Office. | 1.7 |
AttachmentsChanged |
Une pièce jointe a été ajoutée à l’élément ou supprimée de celui-ci. Disponible uniquement avec l’implémentation du volet Office. | 1.8 |
EnhancedLocationsChanged |
L’emplacement du rendez-vous sélectionné a changé. Disponible uniquement avec l’implémentation du volet Office. | 1.8 |
InfobarClicked |
Une action a été sélectionnée dans un message de notification. Disponible uniquement avec l’implémentation du volet Office. | 1.10 |
RecipientsChanged |
La liste des destinataires de l’élément sélectionné ou du lieu de rendez-vous a été modifié. Disponible uniquement avec l’implémentation du volet Office. | 1.7 |
RecurrenceChanged |
La périodicité de la série sélectionnée a été modifiée. Disponible uniquement avec l’implémentation du volet Office. | 1.7 |
SensitivityLabelChanged |
L’étiquette de confidentialité d’un message ou d’un rendez-vous en mode composition a changé. Disponible uniquement avec l’implémentation du volet Office. | 1.13 |
SpamReporting |
Un message non sollicité a été signalé dans Outlook. Disponible uniquement avec une commande de fonction. | 11.4 |
Exemple
L’exemple de code JavaScript suivant montre comment accéder à la propriété subject
de l’élément actif dans 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.
});
};