Office.SmartAlertsEventCompletedOptions interface
Spécifie le comportement d’un complément Alertes intelligentes lorsqu’il termine le traitement d’un OnMessageSend
événement ou OnAppointmentSend
.
Remarques
Exemples
// The following example checks whether a location is specified in an appointment before it's sent.
function onAppointmentSendHandler(event) {
Office.context.mailbox.item.location.getAsync({ asyncContext: event }, asyncResult => {
const event = asyncResult.asyncContext;
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
// If the add-in is unable to retrieve the appointment's location, the appointment isn't sent.
event.completed({ allowEvent: false, errorMessage: "Failed to get the appointment's location." });
return;
}
if (asyncResult.value === "") {
// If no location is specified, the appointment isn't sent and the user is alerted to include a location.
event.completed(
{
allowEvent: false,
cancelLabel: "Add a location",
commandId: "msgComposeOpenPaneButton",
contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
errorMessage: "Don't forget to add a meeting location.",
sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
}
);
} else {
// If a location is specified, the appointment is sent.
event.completed({ allowEvent: true });
}
});
}
Propriétés
allow |
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit poursuivre l’exécution ou être annulé. Par exemple, un complément qui gère l’événement ou |
cancel |
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes. |
command |
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes. |
context |
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa |
error |
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa |
send |
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes. |
Détails de la propriété
allowEvent
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit poursuivre l’exécution ou être annulé. Par exemple, un complément qui gère l’événement ou OnAppointmentSend
peut définir false
allowEvent
sur OnMessageSend
pour annuler l’envoi d’un élément. Pour obtenir un exemple complet, consultez la procédure pas à pas des alertes intelligentes.
allowEvent?: boolean;
Valeur de propriété
boolean
Remarques
[ Ensemble d’API : Boîte aux lettres 1.12 ]
Niveau d’autorisation minimal (Outlook) : restreint
Mode Outlook applicable : Composer
cancelLabel
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent
propriété sur false
, cette propriété personnalise le texte du bouton Ne pas envoyer dans la boîte de dialogue Alertes intelligentes. Le texte personnalisé doit contenir 20 caractères ou moins.
Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
cancelLabel?: string;
Valeur de propriété
string
Remarques
[ Ensemble d’API : préversion de boîte aux lettres ]
Niveau d’autorisation minimal (Outlook) : restreint
Mode Outlook applicable : Composer
commandId
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent
propriété sur false
, cette propriété spécifie l’ID du volet Office qui s’ouvre lorsque le bouton Ne pas envoyer est sélectionné dans la boîte de dialogue Alertes actives.
Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
commandId?: string;
Valeur de propriété
string
Remarques
[ Ensemble d’API : préversion de boîte aux lettres ]
Niveau d’autorisation minimal (Outlook) : restreint
Mode Outlook applicable : Composer
Important:
La commandId
valeur doit correspondre à l’ID du volet Office spécifié dans le manifeste de votre complément. Le balisage dépend du type de manifeste utilisé par votre complément.
Manifeste XML :
id
attribut de l’élément Control représentant le volet Office.Manifeste unifié pour Microsoft 365 (préversion) : propriété « id » de la commande du volet Office dans le tableau « controls ».
Si vous spécifiez l’option contextData
dans votre event.completed
appel, vous devez également affecter un ID de volet Office à l’option commandId
. Sinon, les données JSON affectées à contextData
sont ignorées.
contextData
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent
propriété sur false
, cette propriété spécifie toutes les données JSON transmises au complément pour traitement lorsque le bouton Ne pas envoyer est sélectionné dans la boîte de dialogue Alertes intelligentes.
contextData?: any;
Valeur de propriété
any
Remarques
[ Ensemble d’API : préversion de boîte aux lettres ]
Niveau d’autorisation minimal (Outlook) : restreint
Mode Outlook applicable : Composer
Important:
Dans Outlook sur Windows, le
any
type est pris en charge à partir de la version 2402 (build 17308.20000). Dans les versions antérieures d’Outlook sur Windows, seul lestring
type est pris en charge.Si vous spécifiez l’option
contextData
dans votreevent.completed
appel, vous devez également affecter un ID de volet Office à l’optioncommandId
. Sinon, les données JSON affectées àcontextData
sont ignorées.Pour récupérer la valeur de la
contextData
propriété, vous devez appelerOffice.context.mailbox.item.getInitializationContextAsync
dans l’implémentation JavaScript de votre volet Office. Si vous créez une chaîne JSON à l’aideJSON.stringify()
de et que vous l’attribuez à lacontextData
propriété , vous devez analyser la chaîne à l’aideJSON.parse()
de une fois que vous l’avez récupérée.
errorMessage
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent
propriété sur false
, cette propriété définit le message d’erreur affiché à l’utilisateur. Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
errorMessage?: string;
Valeur de propriété
string
Remarques
[ Ensemble d’API : Boîte aux lettres 1.12 ]
Niveau d’autorisation minimal (Outlook) : restreint
Mode Outlook applicable : Composer
sendModeOverride
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent
propriété sur false
, cette propriété remplace l’option de mode d’envoi spécifiée dans le manifeste au moment de l’exécution.
Pour obtenir un exemple, consultez la procédure pas à pas alertes intelligentes.
sendModeOverride?: MailboxEnums.SendModeOverride | string;
Valeur de propriété
Office.MailboxEnums.SendModeOverride | string
Remarques
[ Ensemble d’API : préversion de boîte aux lettres ]
Niveau d’autorisation minimal (Outlook) : restreint
Mode Outlook applicable : Composer
Important : Actuellement, sendModeOverride
ne peut être défini que sur l’option d’invite utilisateur .
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour