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 APIs: Caixa de Correio 1.12

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

Modo do Outlook aplicável: Compose

Usada por

Office.MailboxEvent: concluído

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 lida com o `OnMessageSend` evento ou `OnAppointmentSend` pode ser definido `allowEvent` como `false` para cancelar o envio de um item. Para obter um exemplo completo, consulte o passo a passo de Alertas Inteligentes.
cancelLabel	Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua `allowEvent` propriedade como `false`, essa propriedade personaliza o texto de um botão na caixa de diálogo Alertas inteligentes. O texto personalizado deve ter 20 caracteres ou menos. Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.
commandId	Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua `allowEvent` propriedade como `false`, essa propriedade especifica a ID do painel de tarefas ou da função que é executada a partir de um botão na caixa de diálogo Alertas inteligentes. Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.
contextData	Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua `allowEvent` propriedade como `false`, essa propriedade especifica todos os dados JSON passados ao suplemento para processamento quando o botão aplicável é selecionado na caixa de diálogo Alertas inteligentes.
errorMessage	Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua `allowEvent` propriedade como `false`, essa propriedade define a mensagem de erro exibida para o usuário. Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.
errorMessageMarkdown	Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua `allowEvent` propriedade como `false`, essa propriedade define a mensagem de erro exibida para o usuário. A mensagem de erro é formatada usando Markdown. Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.
sendModeOverride	Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua `allowEvent` propriedade como `false`, essa propriedade substitui a opção de modo de envio especificada no manifesto em tempo de execução. Para obter um exemplo, consulte o passo a passo dos 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 lida com o OnMessageSend evento ou OnAppointmentSend pode ser definido allowEvent como false para cancelar o envio de um item. Para obter um exemplo completo, consulte o passo a passo de Alertas Inteligentes.

allowEvent?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: Caixa de Correio 1.12

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

Modo do Outlook aplicável: Compose

cancelLabel

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua allowEvent propriedade como false, essa propriedade personaliza o texto de um botão na caixa de diálogo Alertas inteligentes. O texto personalizado deve ter 20 caracteres ou menos.

Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.

cancelLabel?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: Caixa de Correio 1.14

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

Modo do Outlook aplicável: Compose

Importante:

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

No Outlook na Web, no Mac (em versão prévia a partir da versão 16.105 (Build 25121117)), no novo Outlook no Windows e no Outlook clássico no Windows a partir da versão 2412 (build 18324.20000), a cancelLabel propriedade personaliza o texto do botão Executar Ação. O botão Executar Ação só aparecerá na caixa de diálogo Alertas Inteligentes se a commandId opção estiver configurada event.completed na chamada. A opção deve ser configurada se você quiser personalizar o texto do botão de diálogo. Nessa implementação, o botão Não Enviar cancela o item que está sendo enviado. Seu texto e funcionalidade não podem ser personalizados. Se você personalizou anteriormente o texto do botão Não enviar sem atribuir a ele um painel de tarefas ou comando de função, seu texto personalizado não terá efeito nas versões mais recentes do cliente Outlook. Se você atribuiu anteriormente um painel de tarefas ou comando de função ao botão Não Enviar , nenhuma ação adicional será necessária para implementar o botão Executar Ação nas versões mais recentes. O botão Executar Ação padrão ou personalizado aparecerá automaticamente na próxima vez que um usuário receber uma caixa de diálogo de Alertas Inteligentes. Embora nenhuma alteração de implementação seja necessária, recomendamos notificar os usuários sobre essa experiência atualizada.
No Outlook clássico no Windows (anterior à Versão 2412 (Build 18324.20000) e no Outlook no Mac (anterior à Versão 16.105 (Build 25121117)), a cancelLabel propriedade personaliza o texto do botão Não Enviar . O botão Não enviar cancela o item que está sendo enviado.

commandId

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua allowEvent propriedade como false, essa propriedade especifica a ID do painel de tarefas ou da função que é executada a partir de um botão na caixa de diálogo Alertas inteligentes.

Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.

commandId?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: Caixa de Correio 1.14 (suporte ao painel de tarefas), Caixa de Correio 1.15 (suporte a comando de função)

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

Modo do Outlook aplicável: Compose

Importante:

O commandId valor deve corresponder ao painel de tarefas ou à ID de função especificada no manifesto do seu suplemento. A marcação depende do tipo de manifesto que seu suplemento usa.

Manifesto somente do suplemento: o id atributo do elemento Control que representa o painel de tarefas ou função.
Manifesto unificado para o Microsoft 365: a propriedade "id" do painel de tarefas ou o comando de função na matriz "controles".

O botão na caixa de diálogo Alertas Inteligentes que abre um painel de tarefas ou executa uma função varia dependendo do cliente e da versão do Outlook. No Outlook na Web, no Mac (em versão prévia a partir da versão 16.105 (Build 25121117)), no novo Outlook no Windows e no Outlook clássico no Windows a partir da versão 2412 (build 18324.20000), o botão Executar Ação abre um painel de tarefas ou executa uma função. Nessa implementação, o botão Não Enviar cancela o item que está sendo enviado. Seu texto e funcionalidade não podem ser personalizados. Em versões anteriores com suporte do Outlook clássico no Windows (versões anteriores à Versão 2412 (Build 18324.20000) com suporte para requisitos de caixa de correio definidos 1.14) e Outlook no Mac, o botão Não Enviar abre um painel de tarefas ou executa uma função.

Se você já personalizou o texto e a funcionalidade do botão Não Enviar no suplemento Alertas Inteligentes antes da Versão 2412 (Build 18324.20000) do Outlook clássico no Windows ou anterior à Versão 16.105 (Build 25121117) do Outlook no Mac, nenhuma ação adicional é necessária para implementar o botão Executar Ação nas versões mais recentes com suporte. O botão Executar Ação padrão ou personalizado aparecerá automaticamente na próxima vez que um usuário receber uma caixa de diálogo de Alertas Inteligentes. Embora nenhuma alteração de implementação seja necessária, recomendamos notificar os usuários sobre essa experiência atualizada.

Se você especificar uma ID de comando que não existe, dependendo do cliente Outlook, o botão Executar Ação ou Não Enviar simplesmente cancela o item que está sendo enviado.

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

Quando você configura um botão na caixa de diálogo Alertas Inteligentes para executar uma função, um botão para a função também é adicionado à faixa de opções ou à barra de ações do cliente Outlook. Use a contextData opção para distinguir quando um usuário executa a função da caixa de diálogo Alertas inteligentes.

A programação de um botão na caixa de diálogo Alertas Inteligentes para executar uma função está disponível para visualização no Outlook no Mac a partir da Versão 16.105 (Build 25121117). Para testar esse recurso, ingresse no programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar as builds beta do Office.

contextData

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua allowEvent propriedade como false, essa propriedade especifica todos os dados JSON passados 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 APIs: Caixa de Correio 1.14

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

Modo do Outlook aplicável: Compose

Importante:

No Outlook no Windows, o any tipo tem suporte a partir da versão 2402 (build 17308.20000). Em versões anteriores do Outlook no Windows, apenas o string tipo é compatível.
Se você especificar a contextData opção em sua event.completed chamada, também deverá atribuir um painel de tarefas ou uma ID de função à commandId opção. Caso contrário, os dados JSON atribuídos serão contextData ignorados.
O botão de diálogo que passa o contextData valor para o suplemento varia dependendo do cliente Outlook e de sua versão. Para obter mais informações, consulte Personalizar o texto e a funcionalidade de um botão na caixa de diálogo.
Para recuperar o contextData valor da propriedade, você deve chamar Office.context.mailbox.item.getInitializationContextAsync a implementação JavaScript do painel de tarefas. Se você criar uma cadeia de caracteres JSON usando JSON.stringify() e atribuí-la à contextData propriedade, deverá analisar a cadeia de caracteres usando JSON.parse() uma vez que você recuperá-la.
Quando você configura um botão na caixa de diálogo Alertas Inteligentes para executar uma função, um botão para a função também é adicionado à faixa de opções ou à barra de ações do cliente Outlook. Use a contextData opção para distinguir quando um usuário executa a função da caixa de diálogo Alertas inteligentes.
Para evitar que o painel de tarefas de um suplemento de Alertas inteligentes seja reiniciado se já estiver aberto, implemente um manipulador para o Office.EventType.InitializationContextChanged evento. Em seguida, você pode passar os argumentos de evento para a contextData propriedade.

errorMessage

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

errorMessage?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: Caixa de Correio 1.12

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

Modo do Outlook aplicável: Compose

Importante:

A mensagem de erro deve ter 500 caracteres ou menos.
Se você não especificar uma mensagem na errorMessage propriedade, a seguinte mensagem padrão será exibida: "<O nome> do suplemento está impedindo que este email seja enviado".

errorMessageMarkdown

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua allowEvent propriedade como false, essa propriedade define a mensagem de erro exibida para o usuário. A mensagem de erro é formatada usando Markdown. Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.

errorMessageMarkdown?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: Caixa de Correio 1.15

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

Modo do Outlook aplicável: Compose

Importante

A errorMessageMarkdown propriedade está disponível para visualização no Outlook no Mac a partir da Versão 16.103 (Build 25102433). Para testar a propriedade, ingresse no programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar as builds beta do Office.
A mensagem de erro formatada deve ter 500 caracteres ou menos.
Para obter orientações sobre elementos Markdown suportados, consulte Limitações da formatação da mensagem de diálogo usando Markdown.
Se você formatar a mensagem de diálogo usando a errorMessageMarkdown propriedade, recomendamos que você também adicione uma versão de texto simples da mensagem usando a errorMessage propriedade. Isso garante que a mensagem seja exibida corretamente em clientes do Outlook que não oferecem suporte a Markdown.

sendModeOverride

Quando você usa o método concluído para sinalizar a conclusão de um manipulador de eventos e define sua allowEvent propriedade como false, essa propriedade substitui a opção de modo de envio especificada no manifesto em tempo de execução.

Para obter um exemplo, consulte o passo a passo dos Alertas Inteligentes.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Valor da propriedade

Office.MailboxEnums.SendModeOverride | string

Comentários

Conjunto de APIs: Caixa de Correio 1.14

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

Modo do Outlook aplicável: Compose

Importante: atualmente, sendModeOverride só pode ser definido para a opção de prompt ao usuário .

Comentários

Esta página foi útil?