Ativar o seu suplemento do Outlook sem o Painel de Leitura ativado ou uma mensagem selecionada

  • Artigo

Com uma configuração de manifesto simples, pode criar suplementos do Outlook para a superfície Leitura da Mensagem que ativam um painel de tarefas sem o Painel de Leitura ativado ou uma mensagem selecionada pela primeira vez a partir da caixa de correio. Esta funcionalidade chama-se "sem contexto de item". Siga as instruções para saber mais e desbloquear capacidades adicionais para o seu suplemento. Por exemplo, pode permitir que os seus utilizadores acedam a conteúdos de diferentes origens de dados, como o OneDrive ou um sistema de gestão de relações com os clientes (CRM), diretamente a partir do cliente Outlook.

Observação

O suporte para esta funcionalidade foi introduzido no conjunto de requisitos 1.13. Confira, clientes e plataformas que oferecem suporte a esse conjunto de requisitos.

Embora Outlook na Web e novo requisito de suporte do Outlook no Windows definido como 1.13, um suplemento não será ativado se o Painel de Leitura estiver oculto ou se não estiver selecionada uma mensagem. Para obter mais informações, consulte Suporte de funcionalidades no Outlook na Web e novo Outlook no Windows.

Configurar seu ambiente

Conclua o guia de introdução do Outlook no qual cria um suplemento do Outlook com o gerador Yeoman para Suplementos do Office.

Para ativar esta funcionalidade num projeto de suplemento pré-existente, veja Configurar o manifesto.

Configurar o manifesto

Os passos para configurar o manifesto variam consoante o tipo de manifesto utilizado pelo suplemento.

  1. No seu editor de código preferido, abra o projeto de início rápido do Outlook que criou.

  2. Abra o ficheiro manifest.json localizado na raiz do projeto.

  3. No primeiro objeto na matriz "extensions.runtimes", faça o seguinte:

    1. Altere "requirements.capabilities.minVersion" para "1.13".
    2. Adicione uma propriedade "supportsNoItemContext" ao objeto na matriz "actions" e defina o respetivo valor como true.
    3. Adicione uma propriedade "seleção múltipla" ao mesmo objeto e defina-a como true.
    4. Altere a propriedade "afixável" no mesmo objeto para true.

    Quando terminar, deverá ter o seguinte aspeto.

    "runtimes": [
    {
        "requirements": {
            "capabilities": [
                {
                    "name": "Mailbox",
                    "minVersion": "1.13"
                }
            ]
        },
        "id": "TaskPaneRuntime",
        "type": "general",
        "code": {
            "page": "https://localhost:3000/taskpane.html"
        },
        "lifetime": "short",
        "actions": [
            {
                "id": "TaskPaneRuntimeShow",
                "type": "openPage",
                "view": "dashboard",
                "pinnable": true,
                "supportsNoItemContext": true,
                "multiselect": true
            }
        ]
    }
]

  4. Elimine o segundo objeto na matriz "extensions.runtimes", cujo "id" é "CommandsRuntime".

  5. A matriz "extensions.ribbons.tabs.groups.controls" tem dois objetos. Elimine o segundo, cujo "ID" é "ActionButton".

Configurar o painel de tarefas

  1. No projeto, navegue para a pasta do painel de tarefas e, em seguida, abra taskpane.html.

  2. Substitua todo <o elemento do corpo> pela seguinte marcação.

    <body class="ms-font-m ms-welcome ms-Fabric">
    <header class="ms-welcome__header ms-bgColor-neutralLighter">
        <img width="90" height="90" src="../../assets/logo-filled.png" alt="logo" title="Add-in logo" />
        <h1 class="ms-font-su">Activate your add-in without enabling the Reading Pane or selecting a message</h1>
    </header>
    <section id="sideload-msg" class="ms-welcome__main">
        <h2 class="ms-font-xl">Please <a target="_blank" href="https://video2.skills-academy.com/office/dev/add-ins/testing/test-debug-office-add-ins#sideload-an-office-add-in-for-testing">sideload</a> your add-in to see app body.</h2>
    </section>
    <main id="app-body" class="ms-welcome__main" style="display: none;">
        <ul class="ms-List ms-welcome__features">
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--CheckList ms-font-xl"></i>
                <span class="ms-font-m">Item multi-select is automatically enabled when the <b>SupportsNoItemContext</b> manifest element is set to <code>true</code>. You can test this by selecting multiple messages in Outlook, then choosing <b>Show Taskpane</b> from the ribbon.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--Pin ms-font-xl"></i>
                <span class="ms-font-m">Support to pin the task pane is also automatically enabled. You can test this by selecting the <b>pin</b> icon from the top right corner of the task pane.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--DockRight ms-font-xl"></i>
                <span class="ms-font-m">This feature can only be implemented with a task pane.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--Design ms-font-xl"></i>
                <span class="ms-font-m">Implement your scenario using this feature today! For example, enable your users to access content from different data sources, such as OneDrive or your customer relationship management (CRM) system, without first selecting a message.</span>
            </li>
        </ul>
    </main>
</body>

  3. Salve suas alterações.

Atualizar o ficheiro JavaScript do painel de tarefas

  1. Na pasta do painel de tarefas , abra taskpane.js.

  2. Navegue para a função e substitua o Office.onReady respetivo conteúdo pelo seguinte código.

    if (info.host === Office.HostType.Outlook) {
    document.getElementById("sideload-msg").style.display = "none";
    document.getElementById("app-body").style.display = "flex";
}

  3. Salve suas alterações.

Experimente

  1. Num terminal, execute o seguinte código no diretório de raiz do projeto. Esta ação inicia o servidor Web local e efetua sideloads do seu suplemento.

    npm start

    Dica

    Se o seu suplemento não carregar automaticamente em sideload, siga as instruções em Sideload Suplementos do Outlook para testar para o sideload manualmente no Outlook.

  2. Navegue para a sua caixa de entrada e efetue um dos seguintes procedimentos:

  3. Selecione Mostrar Painel de Tarefas no friso.

  4. Explore e teste as sugestões listadas no painel de tarefas.

  5. Quando quiser parar o servidor Web local e desinstalar o suplemento, siga as instruções aplicáveis:

    • Para parar o servidor, execute o seguinte comando. Se tiver utilizado npm start, o seguinte comando também deve desinstalar o suplemento.

      npm stop

    • Se tiver carregado manualmente o suplemento em sideload, consulte Remover um suplemento sideloaded.

Suporte para as funcionalidades do painel de tarefas de seleção múltipla e afixável do item

Ativar o suporte para nenhum contexto de item no manifesto ativa automaticamente o suporte para funcionalidades do painel de tarefas de seleção múltipla e afixável de itens, mesmo que estas funcionalidades não estejam explicitamente configuradas no manifesto.

Suporte de funcionalidades no Outlook na Web e no novo Outlook no Windows

No Outlook na Web e no novo Outlook no Windows, os suplementos que implementam nenhum contexto de item não são ativados quando o Painel de Leitura está oculto ou quando uma mensagem não está selecionada. Isto acontece porque os comandos de suplemento no Outlook na Web não aparecem no friso. Para ativar um suplemento a partir da superfície De Leitura da Mensagem, primeiro tem de selecionar uma mensagem e, em seguida, selecionar o comando de suplemento na barra de ação da mensagem.

Uma vez que ativar nenhum contexto de item ativa automaticamente a funcionalidade de seleção múltipla de itens, poderá ativar o seu suplemento no Outlook na Web e no novo Outlook no Windows em vários itens de correio.

Confira também