Office.SmartAlertsEventCompletedOptions interface

Пакет:

outlook

Указывает поведение надстройки Smart Alerts по завершении обработки OnMessageSend события или OnAppointmentSend .

Комментарии

[ Набор API: Почтовый ящик 1.12 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

Примеры

// 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.",
                    errorMessageMarkdown: `
                        Don't forget to add a meeting location.\n\n
                        **Tip**: For a list of locations,
                        see [Meeting Locations]("https://www.contoso.com/meeting-locations).`,
                    sendModeOverride: Office.MailboxEnums.SendModeOverride.PromptUser
                }
            );
        } else {
            // If a location is specified, the appointment is sent.
            event.completed({ allowEvent: true });
        }
    });
}

Свойства

allowEvent	При использовании метода completed для сигнала о завершении обработчика событий это значение указывает, следует ли продолжить выполнение обработанного события или отменить его. Например, надстройка, обрабатывающая OnMessageSend событие или OnAppointmentSend , может присвоить значение allowEvent , false чтобы отменить отправку элемента. Полный пример см. в пошаговом руководстве по интеллектуальным оповещениям.
cancelLabel	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство настраивает текст кнопки Не отправлять в диалоговом окне Смарт-оповещения. Пользовательский текст должен содержать не более 20 символов. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.
commandId	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство задает идентификатор области задач или функции, которая запускается при нажатии кнопки Не отправлять в диалоговом окне Смарт-оповещения. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.
contextData	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство указывает все данные JSON, передаваемые надстройке для обработки, если в диалоговом окне Смарт-оповещения выбрана кнопка Не отправлять .
errorMessage	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство задает сообщение об ошибке, отображаемое для пользователя. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.
errorMessageMarkdown	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство задает сообщение об ошибке, отображаемое для пользователя. Сообщение об ошибке отформатировано с помощью Markdown. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.
sendModeOverride	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство переопределяет параметр режима отправки , указанный в манифесте во время выполнения. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.

Сведения о свойстве

allowEvent

При использовании метода completed для сигнала о завершении обработчика событий это значение указывает, следует ли продолжить выполнение обработанного события или отменить его. Например, надстройка, обрабатывающая OnMessageSend событие или OnAppointmentSend , может присвоить значение allowEvent , false чтобы отменить отправку элемента. Полный пример см. в пошаговом руководстве по интеллектуальным оповещениям.

allowEvent?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: Почтовый ящик 1.12 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

cancelLabel

Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство настраивает текст кнопки Не отправлять в диалоговом окне Смарт-оповещения. Пользовательский текст должен содержать не более 20 символов.

Пример см. в пошаговом руководстве по интеллектуальным оповещениям.

cancelLabel?: string;

Значение свойства

string

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

commandId

Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство задает идентификатор области задач или функции, которая запускается при нажатии кнопки Не отправлять в диалоговом окне Смарт-оповещения.

Пример см. в пошаговом руководстве по интеллектуальным оповещениям.

commandId?: string;

Значение свойства

string

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

Важно!

Значение commandId должно соответствовать идентификатору области задач или функции, указанному в манифесте надстройки. Разметка зависит от типа манифеста, используемого надстройкой.

• Манифест только надстройки. Атрибут id элемента Control , представляющего область задач или функцию.

• Унифицированный манифест для Microsoft 365: свойство id области задач или команды функции в массиве controls.

Если параметр указан в вызове contextDataevent.completed , необходимо также назначить параметру область задач или идентификатор commandId функции. В противном случае назначенные contextData данные JSON игнорируются.

contextData

Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство указывает все данные JSON, передаваемые надстройке для обработки, если в диалоговом окне Смарт-оповещения выбрана кнопка Не отправлять .

contextData?: any;

Значение свойства

any

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

Важно!

• В Outlook для Windows тип поддерживается начиная any с версии 2402 (сборка 17308.20000). В более ранних версиях Outlook в Windows поддерживался только string тип .

• Если вы указываете contextData параметр в вызове event.completed , необходимо также назначить параметру commandId идентификатор области задач. В противном случае назначенные contextData данные JSON игнорируются.

• Чтобы получить значение contextData свойства, необходимо вызвать Office.context.mailbox.item.getInitializationContextAsync в реализации JavaScript области задач. Если вы создаете строку JSON с помощью JSON.stringify() и присваиваете ее свойству contextData , необходимо проанализировать строку с помощью JSON.parse() после ее извлечения.

errorMessage

Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство задает сообщение об ошибке, отображаемое для пользователя. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.

errorMessage?: string;

Значение свойства

string

Комментарии

[ Набор API: Почтовый ящик 1.12 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

errorMessageMarkdown

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство задает сообщение об ошибке, отображаемое для пользователя. Сообщение об ошибке отформатировано с помощью Markdown. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.

errorMessageMarkdown?: string;

Значение свойства

string

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

Важно!

• Отформатированное сообщение об ошибке должно содержать не более 500 символов.

• Рекомендации по поддерживаемым элементам Markdown см. в разделе Ограничения форматирования диалогового сообщения с помощью Markdown.

• При форматировании диалогового сообщения с помощью errorMessageMarkdown свойства рекомендуется также добавить версию сообщения в виде открытого текста с помощью errorMessage свойства . Это гарантирует правильное отображение сообщения в клиентах Outlook, которые не поддерживают Markdown.

sendModeOverride

Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его allowEvent свойства falseзначение , это свойство переопределяет параметр режима отправки , указанный в манифесте во время выполнения.

Пример см. в пошаговом руководстве по интеллектуальным оповещениям.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Значение свойства

Office.MailboxEnums.SendModeOverride | string

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):ограниченный

Применимый режим Outlook: Compose

Важно! В настоящее sendModeOverride время можно задать только параметр запрашивать пользователя .