Office.SmartAlertsEventCompletedOptions interface

Пакет:: outlook

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

// 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 для передачи сигнала о завершении обработчика событий и присвоения свойству `allowEventfalse`значения , это свойство указывает все данные JSON, передаваемые надстройке для обработки при выборе соответствующей кнопки в диалоговом окне смарт-оповещений.
errorMessage	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его `allowEvent` свойства `false`значение , это свойство задает сообщение об ошибке, отображаемое для пользователя. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.
errorMessageMarkdown	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его `allowEvent` свойства `false`значение , это свойство задает сообщение об ошибке, отображаемое для пользователя. Сообщение об ошибке отформатировано с помощью Markdown. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.
sendModeOverride	Если вы используете метод completed , чтобы сообщить о завершении обработчика событий и задать для его `allowEvent` свойства `false`значение , это свойство переопределяет параметр режима отправки , указанный в манифесте во время выполнения. Пример см. в пошаговом руководстве по интеллектуальным оповещениям.

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

allowEvent

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

allowEvent?: boolean;

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

boolean

cancelLabel

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

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

cancelLabel?: string;

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

string

В Outlook в Интернете, новом Outlook для Windows и классическом Outlook в Windows начиная с версии 2412 (сборка 18324.20000), cancelLabel свойство настраивает текст кнопки "Принять меры". Кнопка "Принять меры " отображается только в диалоговом окне Смарт-оповещения, commandId если параметр настроен в вызове event.completed . Параметр необходимо настроить, если вы хотите настроить текст кнопки диалогового окна. В этой реализации кнопка "Не отправлять" отменяет отправку элемента. Его текст и функциональность нельзя настроить. Если вы ранее настроили текст кнопки "Не отправлять ", не назначив ему команду области задач или функции, настраиваемый текст не будет действовать в последних версиях клиента Outlook. Если ранее вы назначили кнопке "Не отправлять " команду области задач или функции, для реализации кнопки "Действие " в последних версиях не требуется никаких дополнительных действий. Кнопка по умолчанию или настроенная кнопка "Принять меры " будет автоматически отображаться при следующем получении пользователем диалогового окна смарт-оповещений. Хотя изменения в реализации не требуются, рекомендуется уведомлять пользователей об этом обновленном интерфейсе.
В более ранних поддерживаемых версиях классического Outlook для Windows (версии до версии 2412 (сборка 18324.20000), которые поддерживали набор обязательных почтовых ящиков 1.14) и Outlook на Mac, cancelLabel свойство настраивает текст кнопки "Не отправлять ". Кнопка Не отправлять отменяет отправляемый элемент.

commandId

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

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

commandId?: string;

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

string

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

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

Кнопка в диалоговом окне Смарт-оповещения, которая открывает область задач или выполняет функцию, зависит от клиента и версии Outlook. В Outlook в Интернете, новый Outlook для Windows и классический Outlook в Windows начиная с версии 2412 (сборка 18324.20000), кнопка "Принять меры" открывает область задач или запускает функцию. В этой реализации кнопка "Не отправлять" отменяет отправку элемента. Его текст и функциональность нельзя настроить. В более ранних поддерживаемых версиях классического Outlook для Windows (версии до версии 2412 (сборка 18324.20000), которые поддерживали набор обязательных почтовых ящиков 1.14), и Outlook на Mac кнопка "Не отправлять" открывает область задач или запускает функцию.

Если вы настроили текст и функции кнопки "Не отправлять " в надстройке Smart Alerts до версии 2412 (сборка 18324.20000) классической версии Outlook для Windows, то для реализации кнопки "Принять действия " в последних поддерживаемых версиях не требуется никаких дополнительных действий. Кнопка по умолчанию или настроенная кнопка "Принять меры " будет автоматически отображаться при следующем получении пользователем диалогового окна смарт-оповещений. Хотя изменения в реализации не требуются, рекомендуется уведомлять пользователей об этом обновленном интерфейсе.

Если указать идентификатор команды, который не существует в зависимости от клиента Outlook, кнопка "Принять действие " или "Не отправлять" просто отменяет отправляемый элемент.

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

При настройке кнопки в диалоговом окне смарт-оповещений для запуска функции кнопка для функции также добавляется на ленту или панель действий клиента Outlook. Используйте параметр , contextData чтобы различать, когда пользователь запускает функцию из диалогового окна Смарт-оповещения.

contextData

При использовании метода completed для передачи сигнала о завершении обработчика событий и присвоения свойству allowEventfalseзначения , это свойство указывает все данные JSON, передаваемые надстройке для обработки при выборе соответствующей кнопки в диалоговом окне смарт-оповещений.

contextData?: any;

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

any

В Outlook для Windows тип поддерживается начиная any с версии 2402 (сборка 17308.20000). В более ранних версиях Outlook в Windows поддерживался только string тип .
Если параметр указан в вызове contextDataevent.completed , необходимо также назначить параметру область задач или идентификатор commandId функции. В противном случае назначенные contextData данные JSON игнорируются.
Кнопка диалогового contextData окна, которая передает значение надстройке, зависит от клиента Outlook и его версии. Дополнительные сведения см . в разделе Настройка текста и функциональности кнопки в диалоговом окне.
Чтобы получить значение contextData свойства, необходимо вызвать Office.context.mailbox.item.getInitializationContextAsync в реализации JavaScript области задач. Если вы создаете строку JSON с помощью JSON.stringify() и присваиваете ее свойству contextData , необходимо проанализировать строку с помощью JSON.parse() после ее извлечения.
При настройке кнопки в диалоговом окне смарт-оповещений для запуска функции кнопка для функции также добавляется на ленту или панель действий клиента Outlook. Используйте параметр , contextData чтобы различать, когда пользователь запускает функцию из диалогового окна Смарт-оповещения.
Чтобы предотвратить перезапуск области задач надстройки Smart Alerts, если она уже открыта, реализуйте обработчик для Office.EventType.InitializationContextChanged события. Затем можно передать аргументы события в contextData свойство .

errorMessage

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

errorMessage?: string;

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

string

errorMessageMarkdown

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

errorMessageMarkdown?: string;

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

string

Свойство errorMessageMarkdown доступно для предварительной версии в Outlook на Mac начиная с версии 16.103 (сборка 25102433). Чтобы протестировать свойство, присоединитесь к программе предварительной оценки Microsoft 365 и выберите параметр Канал бета-версии для доступа к бета-сборкам Office.
Отформатированное сообщение об ошибке должно содержать не более 500 символов.
Рекомендации по поддерживаемым элементам Markdown см. в разделе Ограничения форматирования диалогового сообщения с помощью Markdown.
При форматировании диалогового сообщения с помощью errorMessageMarkdown свойства рекомендуется также добавить версию сообщения в виде открытого текста с помощью errorMessage свойства . Это гарантирует правильное отображение сообщения в клиентах Outlook, которые не поддерживают Markdown.

sendModeOverride

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

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

sendModeOverride?: MailboxEnums.SendModeOverride | string;

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

Office.MailboxEnums.SendModeOverride | string

Обратная связь

Была ли эта страница полезна?

Поделиться через

Комментарии

Примеры

Свойства

allowEvent

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

Комментарии

cancelLabel

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

Комментарии

commandId

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

Комментарии

contextData

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

Комментарии

errorMessage

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

Комментарии

errorMessageMarkdown

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

Комментарии

sendModeOverride

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

Комментарии