Compartilhar via

Office.SmartAlertsEventCompletedOptions interface

  • Referência
Pacote:
outlook

Especifica o comportamento de um suplemento De Alertas Inteligentes quando 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 utiliza o método concluído para sinalizar a conclusão de um processador de eventos, este valor indica se o evento processado deve continuar a execução ou se deve ser cancelado. Por exemplo, um suplemento que processa o OnMessageSend evento ou OnAppointmentSend pode ser definido allowEvent para false cancelar o envio de um item. Para obter um exemplo completo, veja as instruções de Alertas Inteligentes.
cancelLabel

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade personaliza o texto de um botão na caixa de diálogo Alertas Inteligentes. O texto personalizado tem de ter 20 carateres ou menos.

Por exemplo, veja as instruções Alertas Inteligentes.
commandId

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade especifica o ID do painel de tarefas ou função que é executado a partir de um botão na caixa de diálogo Alertas Inteligentes.

Por exemplo, veja as instruções Alertas Inteligentes.
contextData

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade especifica quaisquer dados JSON transmitidos ao suplemento para processamento quando o botão aplicável é selecionado na caixa de diálogo Alertas Inteligentes.
errorMessage

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade define a mensagem de erro apresentada ao utilizador. Por exemplo, veja as instruções Alertas Inteligentes.
errorMessageMarkdown

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade define a mensagem de erro apresentada ao utilizador. A mensagem de erro é formatada com Markdown. Por exemplo, veja as instruções Alertas Inteligentes.
sendModeOverride

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade substitui a opção de modo de envio especificada no manifesto no runtime.

Por exemplo, veja as instruções Alertas Inteligentes.

Detalhes da propriedade

allowEvent

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos, este valor indica se o evento processado deve continuar a execução ou se deve ser cancelado. Por exemplo, um suplemento que processa o OnMessageSend evento ou OnAppointmentSend pode ser definido allowEvent para false cancelar o envio de um item. Para obter um exemplo completo, veja as instruções de 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

cancelLabel

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade personaliza o texto de um botão na caixa de diálogo Alertas Inteligentes. O texto personalizado tem de ter 20 carateres ou menos.

Por exemplo, veja as instruções Alertas Inteligentes.

cancelLabel?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Compose

Importante:

O botão personalizável na caixa de diálogo Alertas Inteligentes varia consoante o cliente do Outlook e a respetiva versão.

  • No Outlook na Web, o novo Outlook no Windows e o Outlook clássico no Windows a partir da Versão 2412 (Compilação 18324.20000), a cancelLabel propriedade personaliza o texto do botão Tomar Medidas. O botão Tomar Ação só aparece na caixa de diálogo Alertas Inteligentes se a opção commandId estiver configurada na event.completed chamada. A opção tem de ser configurada se pretender personalizar o texto do botão da caixa de diálogo. Nesta implementação, o botão Não Enviar cancela o item que está a ser enviado. O respetivo texto e funcionalidade não podem ser personalizados. Se tiver personalizado anteriormente o texto do botão Não Enviar sem lhe atribuir um painel de tarefas ou um comando de função, o texto personalizado não entrará em vigor nas versões mais recentes do cliente do Outlook. Se tiver atribuído anteriormente um painel de tarefas ou um comando de função ao botão Não Enviar , não é necessária nenhuma ação adicional para implementar o botão Tomar Medidas nas versões mais recentes. O botão Tomar Ação predefinido ou personalizado será apresentado automaticamente da próxima vez que um utilizador receber uma caixa de diálogo Alertas Inteligentes. Embora não sejam necessárias alterações de implementação, recomendamos que notifique os utilizadores desta experiência atualizada.

  • Em versões anteriores suportadas do Outlook clássico no Windows (versões anteriores à Versão 2412 (Compilação 18324.20000) que suportam o requisito de Caixa de Correio definido 1.14) e o Outlook no Mac (pré-visualização), a cancelLabel propriedade personaliza o texto do botão Não Enviar . O botão Não Enviar cancela o item que está a ser enviado.

commandId

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade especifica o ID do painel de tarefas ou função que é executado a partir de um botão na caixa de diálogo Alertas Inteligentes.

Por exemplo, veja as instruções Alertas Inteligentes.

commandId?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Compose

Importante:

O commandId valor tem de corresponder ao painel de tarefas ou ID de função especificado no manifesto do seu suplemento. A marcação depende do tipo de manifesto que o suplemento utiliza.

  • Manifesto apenas de suplemento: o id atributo do elemento Controlo que representa o painel de tarefas ou a função.

  • Manifesto unificado para o Microsoft 365: a propriedade "id" do painel de tarefas ou comando de função na matriz "controlos".

O botão na caixa de diálogo Alertas Inteligentes que abre um painel de tarefas ou executa uma função varia consoante o cliente e a versão do Outlook. No Outlook na Web, o novo Outlook no Windows e o Outlook clássico no Windows a partir da Versão 2412 (Compilação 18324.20000), o botão Tomar Medidas abre um painel de tarefas ou executa uma função. Nesta implementação, o botão Não Enviar cancela o item que está a ser enviado. O respetivo texto e funcionalidade não podem ser personalizados. Em versões anteriores suportadas do Outlook clássico no Windows (versões anteriores à Versão 2412 (Compilação 18324.20000) que suportam o requisito de Caixa de Correio definido 1.14) e o Outlook no Mac (pré-visualização), o botão Não Enviar abre um painel de tarefas ou executa uma função.

Se tiver personalizado o texto e a funcionalidade do botão Não Enviar no suplemento Alertas Inteligentes antes da Versão 2412 (Compilação 18324.20000) do Outlook clássico no Windows, não é necessária nenhuma ação adicional para implementar o botão Tomar Medidas nas versões suportadas mais recentes. O botão Tomar Ação predefinido ou personalizado será apresentado automaticamente da próxima vez que um utilizador receber uma caixa de diálogo Alertas Inteligentes. Embora não sejam necessárias alterações de implementação, recomendamos que notifique os utilizadores desta experiência atualizada.

Se especificar um ID de comando que não existe, dependendo do seu cliente do Outlook, o botão Tomar Medidas ou Não Enviar simplesmente cancela o item que está a ser enviado.

Se especificar a opção contextData na sua event.completed chamada, também tem de atribuir um painel de tarefas ou ID de função à opção commandId . Caso contrário, os dados JSON atribuídos a contextData são ignorados.

Quando configura um botão na caixa de diálogo Alertas Inteligentes para executar uma função, também é adicionado um botão para a função ao friso ou barra de ação do cliente do Outlook. Utilize a opção contextData para distinguir quando um utilizador executa a função a partir da caixa de diálogo Alertas Inteligentes.

contextData

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade especifica quaisquer dados JSON transmitidos ao suplemento para processamento quando o botão aplicável é selecionado na caixa de diálogo Alertas Inteligentes.

contextData?: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Compose

Importante:

  • No Outlook no Windows, o any tipo é suportado a partir da Versão 2402 (Compilação 17308.20000). Em versões anteriores do Outlook no Windows, apenas o string tipo é suportado.

  • Se especificar a opção contextData na sua event.completed chamada, também tem de atribuir um painel de tarefas ou ID de função à opção commandId . Caso contrário, os dados JSON atribuídos a contextData são ignorados.

  • O botão de caixa de diálogo que transmite o contextData valor ao suplemento varia consoante o cliente do Outlook e a respetiva versão. Para obter mais informações, consulte Personalizar o texto e a funcionalidade de um botão na caixa de diálogo.

  • Para obter o valor da contextData propriedade, tem de chamar Office.context.mailbox.item.getInitializationContextAsync na implementação JavaScript do painel de tarefas. Se criar uma cadeia JSON com JSON.stringify() e atribuí-la à contextData propriedade, tem de analisar a cadeia com JSON.parse() uma vez obtê-la.

  • Quando configura um botão na caixa de diálogo Alertas Inteligentes para executar uma função, também é adicionado um botão para a função ao friso ou barra de ação do cliente do Outlook. Utilize a opção contextData para distinguir quando um utilizador executa a função a partir da caixa de diálogo Alertas Inteligentes.

errorMessage

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade define a mensagem de erro apresentada ao utilizador. Por exemplo, veja as instruções 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

Importante: a mensagem de erro tem de ter 500 carateres ou menos.

errorMessageMarkdown

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade define a mensagem de erro apresentada ao utilizador. A mensagem de erro é formatada com Markdown. Por exemplo, veja as instruções Alertas Inteligentes.

errorMessageMarkdown?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de Correio 1.15 ]

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

Modo Outlook aplicável: Compose

Importante

  • A mensagem de erro formatada tem de ter 500 carateres ou menos.

  • Para obter orientações sobre os elementos markdown suportados, veja Limitações à formatação da mensagem de caixa de diálogo com Markdown.

  • Se formatar a mensagem de diálogo com a errorMessageMarkdown propriedade , recomendamos que também adicione uma versão de texto simples da mensagem com a errorMessage propriedade . Isto garante que a mensagem é apresentada corretamente nos clientes do Outlook que não suportam Markdown.

sendModeOverride

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como false, esta propriedade substitui a opção de modo de envio especificada no manifesto no runtime.

Por exemplo, veja as instruções Alertas Inteligentes.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Valor da propriedade

Office.MailboxEnums.SendModeOverride | string

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Compose

Importante: atualmente, sendModeOverride só pode ser definido para a opção de utilizador de pedido.