Office.SmartAlertsEventCompletedOptions interface

  • Referência
Pacote:
outlook

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

Comentários

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.",
                    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.
cancelLabel

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 personaliza o texto do botão Não Enviar 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 alertas inteligentes.
commandId

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 especifica a ID do painel de tarefas que é aberto quando o botão Não Enviar é selecionado na caixa de diálogo Alertas Inteligentes.

Para obter um exemplo, consulte o passo a passo alertas inteligentes.
contextData

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 especifica todos os dados JSON passados para o suplemento para processamento quando o botão Não Enviar é 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 definir 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 alertas inteligentes.
sendModeOverride

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 substitui a opção de modo de envio especificada no manifesto em runtime.

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

cancelLabel

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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 personaliza o texto do botão Não Enviar 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 alertas inteligentes.

cancelLabel?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: visualização da caixa de correio ]

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

Modo outlook aplicável: compose

commandId

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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 especifica a ID do painel de tarefas que é aberto quando o botão Não Enviar é selecionado na caixa de diálogo Alertas Inteligentes.

Para obter um exemplo, consulte o passo a passo alertas inteligentes.

commandId?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: visualização da caixa de correio ]

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

Modo outlook aplicável: compose

Importante:

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

  • Manifesto XML: o id atributo do elemento Control que representa o painel de tarefas.

  • Manifesto unificado para o Microsoft 365: a propriedade "id" do comando do painel de tarefas na matriz "extensions.ribbons.tabs.groups.controls".

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

contextData

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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 especifica todos os dados JSON passados para o suplemento para processamento quando o botão Não Enviar é selecionado na caixa de diálogo Alertas Inteligentes.

contextData?: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: visualização da caixa de correio ]

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

Modo 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, há suporte apenas para o string tipo.

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

  • Para recuperar o valor da contextData 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, você deverá analisar a cadeia de caracteres usando JSON.parse() depois de recuperá-la.

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 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

sendModeOverride

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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 substitui a opção de modo de envio especificada no manifesto em runtime.

Para obter um exemplo, consulte o passo a passo alertas inteligentes.

sendModeOverride?: MailboxEnums.SendModeOverride | string;

Valor da propriedade

Office.MailboxEnums.SendModeOverride | string

Comentários

[ Conjunto de API: visualização da caixa de correio ]

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

Modo outlook aplicável: compose

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