Office.SmartAlertsEventCompletedOptions interface

Pacote:

outlook

Especifica o comportamento de um suplemento de Alertas Inteligentes quando ele conclui o processamento de um OnMessageSend evento ou OnAppointmentSend .

Comentários

[ Conjunto de API: Caixa de correio 1.12 ]

Nível mínimo de permissão (Outlook): restrito

Modo outlook aplicável: compose

Exemplos

// 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 });
        }
    });
}

Propriedades

allowEvent

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos, esse valor indica se o evento manipulado deve continuar a execução ou ser cancelado. Por exemplo, um suplemento que manipula o OnMessageSend evento ou OnAppointmentSend pode definir allowEvent como false cancelar o envio de um item. Para obter um exemplo completo, consulte o passo a passo alertas inteligentes.

errorMessage

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e definir sua allowEvent propriedade como false, essa propriedade define a mensagem de erro que será exibida para o usuário. Para obter um exemplo, consulte o passo a passo alertas inteligentes.

Detalhes da propriedade

allowEvent

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos, esse valor indica se o evento manipulado deve continuar a execução ou ser cancelado. Por exemplo, um suplemento que manipula o OnMessageSend evento ou OnAppointmentSend pode definir allowEvent como false cancelar o envio de um item. Para obter um exemplo completo, consulte o passo a passo alertas inteligentes.

allowEvent?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: Caixa de correio 1.12 ]

Nível mínimo de permissão (Outlook): restrito

Modo outlook aplicável: compose

errorMessage

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e definir sua allowEvent propriedade como false, essa propriedade define a mensagem de erro que será exibida para o usuário. Para obter um exemplo, consulte o passo a passo alertas inteligentes.

errorMessage?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de correio 1.12 ]

Nível mínimo de permissão (Outlook): restrito

Modo outlook aplicável: compose