Compartilhar via

Criar um suplemento do Outlook para um fornecedor de reunião online

Configurar uma reunião online é uma experiência fundamental para um utilizador do Outlook e é fácil criar uma reunião do Teams com o Outlook. No entanto, criar uma reunião online no Outlook com um serviço que não seja da Microsoft pode ser complicado. Ao implementar esta funcionalidade, os fornecedores de serviços podem simplificar a criação de reuniões online e a experiência de participação para os respetivos utilizadores de suplementos do Outlook.

Neste artigo, irá aprender a configurar o seu suplemento do Outlook para permitir que os utilizadores organizem e participem numa reunião através do seu serviço de reunião online. Ao longo deste artigo, vamos utilizar um fornecedor fictício de serviços de reunião online, "Contoso".

Importante

Esta funcionalidade é suportada no Outlook na Web, Windows (novo e clássico), Mac, Android e iOS com uma subscrição do Microsoft 365.

Configurar seu ambiente

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

Configurar o manifesto

Os passos para configurar o manifesto dependem do tipo de manifesto que selecionou no início rápido.

Observação

Os suplementos que utilizam o manifesto unificado para o Microsoft 365 não são suportados diretamente no Outlook para Mac e em dispositivos móveis. Para executar este tipo de suplemento no Mac e em plataformas móveis, o suplemento tem primeiro de ser publicado no Microsoft Marketplace e, em seguida, implementado no Centro de Administração Microsoft 365. Para obter mais informações, consulte a secção "Suporte de cliente e plataforma" dos Suplementos do Office com o manifesto de aplicação unificada para o Microsoft 365.

  1. Abra o ficheiro manifest.json .

  2. Localize o primeiro objeto na matriz e defina a "authorization.permissions.resourceSpecific" respetiva "name" propriedade como "MailboxItem.ReadWrite.User". Deverá ter este aspeto quando terminar.

    {
    "name": "MailboxItem.ReadWrite.User",
    "type": "Delegated"
}

  3. "validDomains" Na matriz, altere o URL para "https://contoso.com", que é o URL do fornecedor fictício de reuniões online. Quando terminar, a matriz deverá ter o seguinte aspeto.

    "validDomains": [
    "https://contoso.com"
],

  4. Adicione o objeto a seguir à "extensions.runtimes" matriz. Observe o seguinte sobre este código.

    • O "minVersion" conjunto de requisitos da Caixa de Correio está definido como para "1.3" que o runtime não seja iniciado em plataformas e versões do Office onde esta funcionalidade não é suportada.
    • O "id" do runtime está definido como o nome "online_meeting_runtime"descritivo .
    • A "code.page" propriedade está definida como o URL do ficheiro HTML sem IU que irá carregar o comando da função.
    • A "lifetime" propriedade está definida para "short" o que significa que o runtime é iniciado quando o botão de comando da função é selecionado e é encerrado quando a função é concluída. (Em determinados casos raros, o runtime é encerrado antes de o processador ser concluído. Consulte Runtimes nos Suplementos do Office.)
    • Existe uma ação para executar uma função chamada "insertContosoMeeting". Irá criar esta função num passo posterior.
    {
    "requirements": {
        "capabilities": [
            {
                "name": "Mailbox",
                "minVersion": "1.3"
            }
        ],
        "formFactors": [
            "desktop"
        ]
    },
    "id": "online_meeting_runtime",
    "type": "general",
    "code": {
        "page": "https://contoso.com/commands.html"
    },
    "lifetime": "short",
    "actions": [
        {
            "id": "insertContosoMeeting",
            "type": "executeFunction",
            "displayName": "insertContosoMeeting"
        }
    ]
}

  5. Substitua a "extensions.ribbons" matriz pelo seguinte. Observe o seguinte sobre esta marcação.

    • O "minVersion" conjunto de requisitos da Caixa de Correio está definido como para "1.3" que as personalizações do friso não sejam apresentadas em plataformas e versões do Office onde esta funcionalidade não é suportada.
    • A "contexts" matriz especifica que o friso está disponível apenas na janela do organizador dos detalhes da reunião.
    • Existirá um grupo de controlo personalizado no separador predefinido do friso (da janela do organizador dos detalhes da reunião) com o nome Reunião da Contoso.
    • O grupo terá um botão denominado Adicionar reunião.
    • O botão "actionId" foi definido como "insertContosoMeeting", que corresponde ao "id" da ação que criou no passo anterior.
    "ribbons": [
  {
    "requirements": {
        "capabilities": [
            {
                "name": "Mailbox",
                "minVersion": "1.3"
            }
        ],
        "scopes": [
            "mail"
        ],
        "formFactors": [
            "desktop"
        ]
    },
    "contexts": [
        "meetingDetailsOrganizer"
    ],
    "tabs": [
        {
            "builtInTabId": "TabDefault",
            "groups": [
                {
                    "id": "apptComposeGroup",
                    "label": "Contoso meeting",
                    "controls": [
                        {
                            "id": "insertMeetingButton",
                            "type": "button",
                            "label": "Add meeting",
                            "icons": [
                                {
                                    "size": 16,
                                    "url": "icon-16.png"
                                },
                                {
                                    "size": 32,
                                    "url": "icon-32.png"
                                },
                                {
                                    "size": 64,
                                    "url": "icon-64_02.png"
                                },
                                {
                                    "size": 80,
                                    "url": "icon-80.png"
                                }
                            ],
                            "supertip": {
                                "title": "Add a Contoso meeting",
                                "description": "Add a Contoso meeting to this appointment."
                            },
                            "actionId": "insertContosoMeeting",
                        }
                    ]
                }
            ]
        }
    ]
  }
]

Adicionar suporte móvel

  1. Abra o ficheiro manifest.json .

  2. "extensions.ribbons.requirements.formFactors" Na matriz, adicione "mobile" como um item. Quando tiver terminado, a matriz deverá ter o seguinte aspeto.

"formFactors": [
    "desktop",
    "mobile"
]
  1. "extensions.ribbons.contexts" Na matriz, adicione onlineMeetingDetailsOrganizer como um item. Quando tiver terminado, a matriz deverá ter o seguinte aspeto.
"contexts": [
    "meetingDetailsOrganizer",
    "onlineMeetingDetailsOrganizer"
],
  1. "extensions.ribbons.tabs" Na matriz, localize o separador com o "builtInTabId" de "TabDefault". Adicione uma matriz subordinada "customMobileRibbonGroups" à mesma (como elemento da propriedade existente "groups" ). Quando tiver terminado, a "tabs" matriz deverá ter o seguinte aspeto:
"tabs": [
    {
        "builtInTabId": "TabDefault",
        "groups": [
            <-- non-mobile group objects omitted -->
        ],
        "customMobileRibbonGroups": [
            {
                "id": "mobileApptComposeGroup",
                "label": "Contoso Meeting",
                "controls": [
                    { 
                        "id": "mobileInsertMeetingButton",
                        "label": "Add meeting",
                        "type": "mobileButton",
                        "actionId": "insertContosoMeeting",
                        "icons": [
                            {
                                "scale": 1,
                                "size": 25,
                               "url": "https://contoso.com/assets/icon-25.png"
                            },
                            {
                                "scale": 1,
                                "size": 32,
                                "url": "https://contoso.com/assets/icon-32.png"
                            },
                            {
                                "scale": 1,
                                "size": 48,
                                "url": "https://contoso.com/assets/icon-48.png"
                            },                                
                            {
                                "scale": 2,
                                "size": 25,
                                "url": "https://contoso.com/assets/icon-25.png"
                            },
                            {
                                "scale": 2,
                                "size": 32,
                                "url": "https://contoso.com/assets/icon-32.png"
                            },
                            {
                                "scale": 2,
                                "size": 48,
                                "url": "https://contoso.com/assets/icon-48.png"
                            },                                
                            {
                                "scale": 3,
                                "size": 25,
                                "url": "https://contoso.com/assets/icon-25.png"
                            },
                            {
                                "scale": 3,
                                "size": 32,
                                "url": "https://contoso.com/assets/icon-32.png"
                            },
                            {
                                "scale": 3,
                                "size": 48,
                                "url": "https://contoso.com/assets/icon-48.png"
                            }
                        ]
                    }
                ]
            }
        ]
    }
]

Dica

Para saber mais sobre manifestos para suplementos do Outlook, consulte Manifestos de suplementos do Office e Adicionar suporte para comandos de suplementos no Outlook em dispositivos móveis.

Implementar a adição de detalhes da reunião online

Nesta secção, saiba como o script do suplemento pode atualizar a reunião de um utilizador para incluir detalhes da reunião online. O seguinte aplica-se a todas as plataformas suportadas.

  1. No mesmo projeto de início rápido, abra o ficheiro ./src/commands/commands.js no editor de código.

  2. Substitua todo o conteúdo do ficheiro commands.js pelo seguinte JavaScript.

    // 1. How to construct online meeting details.
// Not shown: How to get the meeting organizer's ID and other details from your service.
const newBody = '<br>' +
    '<a href="https://contoso.com/meeting?id=123456789" target="_blank">Join Contoso meeting</a>' +
    '<br><br>' +
    'Phone Dial-in: +1(123)456-7890' +
    '<br><br>' +
    'Meeting ID: 123 456 789' +
    '<br><br>' +
    'Want to test your video connection?' +
    '<br><br>' +
    '<a href="https://contoso.com/testmeeting" target="_blank">Join test meeting</a>' +
    '<br><br>';

let mailboxItem;

// Office is ready.
Office.onReady(function () {
        mailboxItem = Office.context.mailbox.item;
    }
);

// 2. How to define and register a function command named `insertContosoMeeting` (referenced in the manifest)
//    to update the meeting body with the online meeting details.
function insertContosoMeeting(event) {
    // Get HTML body from the client.
    mailboxItem.body.getAsync("html",
        { asyncContext: event },
        function (getBodyResult) {
            if (getBodyResult.status === Office.AsyncResultStatus.Succeeded) {
                updateBody(getBodyResult.asyncContext, getBodyResult.value);
            } else {
                console.error("Failed to get HTML body.");
                getBodyResult.asyncContext.completed({ allowEvent: false });
            }
        }
    );
}
// Register the function.
Office.actions.associate("insertContosoMeeting", insertContosoMeeting);

// 3. How to implement a supporting function `updateBody`
//    that appends the online meeting details to the current body of the meeting.
function updateBody(event, existingBody) {
    // Append new body to the existing body.
    mailboxItem.body.setAsync(existingBody + newBody,
        { asyncContext: event, coercionType: "html" },
        function (setBodyResult) {
            if (setBodyResult.status === Office.AsyncResultStatus.Succeeded) {
                setBodyResult.asyncContext.completed({ allowEvent: true });
            } else {
                console.error("Failed to set HTML body.");
                setBodyResult.asyncContext.completed({ allowEvent: false });
            }
        }
    );
}

Testar e validar o suplemento

Siga a documentação de orientação habitual para testar e validar o suplemento e, em seguida, carregue o manifesto em Outlook na Web, no Windows (novo ou clássico) ou no Mac. Se o seu suplemento também suportar dispositivos móveis, reinicie o Outlook no seu dispositivo Android ou iOS após o sideload. Assim que o suplemento for sideloaded, crie uma nova reunião e verifique se o botão de alternar Microsoft Teams ou Skype é substituído pelo seu.

Criar IU da reunião

Enquanto organizador da reunião, deverá ver ecrãs semelhantes às três imagens seguintes ao criar uma reunião.

O ecrã criar reunião no Android com o botão de alternar contoso desativado. O ecrã criar reunião no Android com um botão de alternar contoso de carregamento. O ecrã criar reunião no Android com o botão de alternar Contoso ativado.

Participar na IU da reunião

Enquanto participante da reunião, deverá ver um ecrã semelhante à imagem seguinte quando vir a reunião.

O ecrã participar na reunião no Android.

Importante

O botão Aderir só é suportado no Outlook na Web, no Mac, no Android, no iOS e no novo Outlook no Windows. Se vir apenas uma ligação de reunião, mas não vir o botão Participar num cliente suportado, poderá ser que o modelo de reunião online do seu serviço não esteja registado nos nossos servidores. Consulte a secção Registar o seu modelo de reunião online para obter detalhes.

Registar o seu modelo de reunião online

O registo do seu suplemento de reunião online é opcional. Só se aplica se quiser apresentar o botão Participar em reuniões, além da ligação da reunião. Depois de publicar o seu suplemento de reunião online e pretende registá-lo, crie um problema no GitHub com a seguinte documentação de orientação. Iremos contactá-lo para coordenar uma linha do tempo de registo.

Importante

  • O botão Aderir só é suportado no Outlook na Web, no Mac, no Android, no iOS e no novo Outlook no Windows.
  • Apenas os suplementos de reunião online publicados no Microsoft Marketplace podem ser registados. Os suplementos de linha de negócio não são suportados.
  1. Crie um novo problema do GitHub.
  2. Defina o Título do novo problema como "Outlook: Registar o modelo de reunião online para o meu serviço", substituindo my-service pelo seu nome de serviço.
  3. No corpo do problema, substitua o texto existente pelo seguinte:
  4. Clique em Submeter novo problema.

Um novo ecrã de problemas do GitHub com o conteúdo de exemplo da Contoso.

Fornecer automaticamente recursos pós-reunião e atualizações aos participantes

Quando uma reunião termina, o organizador e os participantes precisam frequentemente de acesso a recursos importantes, como gravações de vídeo ou transcrições de reuniões. Se disponível, o seu suplemento de reunião online pode atualizar automaticamente o convite para reunião com estes recursos, tornando-os facilmente acessíveis a todos os participantes.

Esta secção descreve como utilizar o Microsoft API do Graph para atualizar um item de calendário com recursos pós-reunião. O conteúdo atualizado de uma reunião será refletido nos calendários do organizador e dos participantes. Além disso, será enviada uma atualização aos participantes.

Esta implementação requer o seguinte:

  • Um token de acesso para efetuar chamadas do Microsoft API do Graph. Para obter orientações, veja Utilizar a API REST do Microsoft Graph a partir de um suplemento do Outlook.
  • Um indicador para o seu suplemento quando uma reunião agendada com o seu suplemento de reunião online tiver terminado.
  • Acesso ao ID do Exchange de uma reunião e ao ID atribuído pelo suplemento.
  • Acesso aos recursos necessários que serão adicionados à reunião.
  • Acesso à instância da reunião criada pelo organizador. Têm de ser efetuadas alterações à instância da reunião do organizador para serem propagadas para a instância da reunião dos participantes.
  1. Quando uma reunião terminar, configure o seu suplemento para obter os recursos que serão adicionados ao objeto de reunião.
  2. Utilize o microsoft API do Graph para obter a instância da reunião do organizador. Certifique-se de que a body propriedade está incluída no pedido. Para obter informações sobre a API, veja Obter evento.
  3. Atualize o corpo da reunião com os recursos de reunião aplicáveis. Para obter informações sobre a API, veja Atualizar evento.

Importante

Ao efetuar alterações à body propriedade de uma reunião, certifique-se de que preserva o blob da reunião online. Remover o blob da reunião do corpo desativa a funcionalidade de reunião online.

Assim que os recursos da reunião tiverem sido adicionados à reunião, é enviada uma atualização aos participantes. As alterações também são refletidas nas instâncias de calendário do organizador e dos participantes.

Segue-se um exemplo de como atualizar o corpo da reunião com uma ligação para uma gravação de vídeo.

const options = {
    authProvider,
};

const client = Client.init(options);

// Get the body of the meeting.
const currentEvent = await client.api('/users/{organizerId}/events/{meetingId}')
    .select('body')
    .get();

const existingBody = currentEvent.body.content;

// Update the body with a link to a video recording.
const meetingResources = `
<br><br>
<h2>Meeting summary</h2>
<p>The team discussed monthly sales targets for Fabrikam. Current market conditions were discussed. A follow-up meeting will be scheduled to finalize revenue goals for the quarter.</p>
<a href="https://contoso.com/recording/123456789" target="_blank">View recording</a>
`;

const updatedBody = existingBody + meetingResources;

const updatedEvent = {
  body: {
    contentType: 'html',
    content: updatedBody
  }
};

// Update the event with the new body content.
await client.api('/users/{organizerId}/events/{meetingId}')
    .update(updatedEvent);

APIs disponíveis

As seguintes APIs estão disponíveis para esta funcionalidade.

Restrições

Aplicam-se várias restrições.

  • Aplicável apenas a fornecedores de serviços de reunião online.
  • Apenas os suplementos instalados pelo administrador serão apresentados no ecrã de composição da reunião, substituindo a opção predefinida do Teams ou do Skype. Os suplementos instalados pelo utilizador não serão ativados.
  • O ícone do suplemento deve estar em tons de cinzento com código #919191 hexadecima ou equivalente noutros formatos de cor.
  • Apenas um comando de função é suportado no modo Appointment Organizer (compose).
  • O suplemento deve atualizar os detalhes da reunião no formulário de compromisso dentro do período de tempo limite de um minuto. No entanto, qualquer tempo despendido numa caixa de diálogo, o suplemento aberto para autenticação, por exemplo, é excluído do período de tempo limite.

Confira também

  • Last updated on