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 do botão Não Enviar 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 quando o botão Não Enviar está selecionado 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 Não Enviar está 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 que será apresentada ao utilizador. 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 do botão Não Enviar 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

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 quando o botão Não Enviar está selecionado 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".

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.

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 Não Enviar está 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 ID do painel de tarefas à opção commandId . Caso contrário, os dados JSON atribuídos a contextData são ignorados.

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

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 que será 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

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.