Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
page_type description products languages extensions urlFragment
sample
This sample illustrates a common scenario where a user shares a link to a resource with a group of users, and they collaborate to review it in a meeting.
office-teams
office
office-365
csharp
contentType createdDate
samples
04/03/2022 11:00:00
officedev-microsoft-teams-samples-msgext-link-unfurling-meeting-csharp

Link unfurling meeting sample

This sample illustrates a common scenario where a user shares a link to a resource (dashboard in this sample) with a group of users, and they collaborate to review it in a meeting.

1. Workflow:

  • User shares a link to a dashboard with a group of users.
  • Teams app unfurls the link to an adaptive card with actions to view it in a stage tab or review it in a meeting.

UML

2. Workflow:

  • Other user in the group chooses to review the dashboard in a meeting.
  • Teams app creates a new meeting, adds a tab (that points to the dashboard originally shared) to a meeting.
  • User automatically joins the meeting and reviews the tab.
  • User shares the tab to meeting stage view with other users.

UML

Interaction with app

AllWorkflow

Prerequisites

Setup

  1. Register a new application in the Azure Active Directory – App Registrations portal. Select New Registration and on the register an application page, set following values:
    • Set name to your app name.
    • Choose the supported account types (any account type will work)
    • Leave Redirect URI empty.
    • Choose Register.
    • On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the appsettings.json.
    • Under Manage, select Expose an API.
    • Select the Set link to generate the Application ID URI in the form of api://{AppID}. Insert your fully qualified domain name (with a forward slash "/" appended to the end) between the double forward slashes and the GUID. The entire ID should have the form of: api://fully-qualified-domain-name/{AppID}
    • ex: api://%ngrokDomain%.ngrok-free.app/00000000-0000-0000-0000-000000000000.
  • Select the Add a scope button. In the panel that opens, enter access_as_user as the Scope name.

  • Set Who can consent? to Admins and users

  • Fill in the fields for configuring the admin and user consent prompts with values that are appropriate for the access_as_user scope:

    • Admin consent display name: Teams can access the user’s profile.
    • Admin consent description: Allows Teams to call the app’s web APIs as the current user.
    • User consent display name: Teams can access the user profile and make requests on the user's behalf.
    • User consent description: Enable Teams to call this app’s APIs with the same rights as the user.
  • Ensure that State is set to Enabled

  • Select Add scope

    • The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with /access_as_user appended to the end:
      • `api://[ngrokDomain].ngrok-free.app/00000000-0000-0000-0000-000000000000/access_as_user.
  • In the Authorized client applications section, identify the applications that you want to authorize for your app’s web application. Each of the following IDs needs to be entered:

    • 1fec8e78-bce4-4aaf-ab1b-5451cc387264 (Teams mobile/desktop application)
    • 5e3ce6c0-2b1f-4285-8d4b-75ee78787346 (Teams web application)
  • Navigate to API Permissions, and make sure to add the follow permissions:

  • Select Add a permission

  •  Select Microsoft Graph -> Delegated permissions.

    • User.Read (enabled by default)
    • TeamsAppInstallation.ReadWriteSelfForChat
    • TeamsTab.ReadWriteForChat
    • Chat.ReadBasic
    • OnlineMeetings.ReadWrite
  • Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

  • Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app. Set a redirect URI:

    • Select Add a platform.
    • Select web.
    • Enter the redirect URI for the app in the following format:
    • https://token.botframework.com/.auth/web/redirect,

    • https://<your_tunnel_domain>/auth-end

    • https://<your_tunnel_domain>/auth-start This will be the page where a successful implicit grant flow will redirect the user.

      Enable implicit grant by checking the following boxes:
      ✔ ID Token
      ✔ Access Token

  • Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the appsettings.json.

    • Add authentication to your Teams bot
      • Follow steps to add OAuth connection setting on this page
    • Make sure to copy and save OAuth connection name.
    • For Scopes, enter all the delegated graph permissions configured in the app(TeamsAppInstallation.ReadWriteSelfForChat TeamsTab.ReadWriteForChat Chat.ReadBasic OnlineMeetings.ReadWrite).
    • Update Bot messaging endpoint to tunnel url with messaging endpoint. (ex. https://<randomsubdomain>.ngrok-free.app/api/messages).

    Add OAuth connection:

    OAuthConnection

  1. Setup for Bot
  • Register a bot with Azure Bot Service, following the instructions here.
  • Ensure that you've enabled the Teams Channel
  • While registering the bot, use https://<your_tunnel_domain>/api/messages as the messaging endpoint.

    NOTE: When you create your bot you will create an App ID and App password - make sure you keep these for later.

  1. Setup NGROK
  • Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"

    Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

    devtunnel host -p 3978 --allow-anonymous
  1. Setup for code
  • Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  • Update the appsettings.json files.

  • Clone the repo or download the sample code to your machine.
  • Update the following settings in appsettings.json
    • MicrosoftAppId - App ID saved earlier.
    • ClientId - App ID saved earlier.
    • TeamsBot:AppId - App ID saved earlier.
    • MicrosoftAppPassword - App secret saved earlier.
    • ClientSecret - App secret saved earlier.
    • AzureAd.domain - Replace with tunnel domain. (ex. <randomsubdomain>.ngrok-free.app)
    • ConnectionName - Connection name
    • BaseUrl - tunnel url saved earlier.
    • TenantId - Tenant ID where you wll run the Teams application.
    • CatalogAppId - App ID in organization's app store saved earlier.
    • GraphApiBeta.Scopes add the following graph permission(TeamsAppInstallation.ReadWriteSelfForChat TeamsTab.ReadWriteForChat Chat.ReadBasic OnlineMeetings.ReadWrite)
  • Update the following in .env under ClientApp.
    • REACT_APP_BASE_URL - tunnel url saved earlier.
    • REACT_APP_AZURE_APP_REGISTRATION_ID - App ID saved earlier.
  • Build and run the sample code in Visual studio / Visual studio code.
  • Run the bot from a terminal or from Visual Studio:

    A) From a terminal, navigate to samples\msgext-link-unfurling-meeting\csharp\Source

    # run the bot
    dotnet run

    B) Or from Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples\msgext-link-unfurling-meeting\csharp\Source folder
    • Select LinkUnfurling.csproj file
    • Press F5 to run the project
  1. Troubleshooting
  • If the web application fails to load, run npm install and npm run build under ClientApp folder.
  • If the meeting setup fails with 403 (Not authorized), make sure you grant admin consent on behalf of all the users.
  • Grant admin conset - https://login.microsoftonline.com/{tenant-id}/adminconsent?client_id={client-id} where
  • {client-id} is the app ID saved earlier.
  • {tenant-id} is your organization's tenant ID.
  1. Setup Manifest for Teams
  • This step is specific to Teams.
    • Edit the manifest.json contained in the samples\msgext-link-unfurling-meeting\csharp\AppManifest folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string <<Your Microsoft App Id>> (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)

    • Edit the manifest.json for websiteUrl,privacyUrl,termsOfUseUrl inside DeveloperTabs . Replace <your_tunnel_domain> with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.

    • Edit the manifest.json for validDomains with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.

    • Edit the manifest.json for showLoadingIndicator Replace false.

    • Zip up the contents of the samples\msgext-link-unfurling-meeting\csharp\AppManifest folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

    • Upload the manifest.zip to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)

    • Add the app to personal/team/groupChat scope (Supported scopes)

Running the sample

Publish the app package to organization's app store:

UploadAppOrg

Build for your org:

CreateOrgSuccessApp

Install App(personal):

InstallApp

SignIn UI :

SignIn

Create link - https://<your_tunnel_domain>/api/messages/dashboard1:

MsgextLinkMeeting

Send Card UI:

SendCard

View:

view

Install App(groupChat):

AddtoChat

Add link unfurling to group chat:

GroupChat

Configuration groupChat UI:

ConfigurationGroup

Shared Dashboard:

ShareDashboard

Join Meeting:

MeetingJoin

Share dashboard screen UI:

ShareDashboardScreen

Screen sharing:

ScreenSharing

Install App(team):

AddtoTeam

Add link unfurling to team:

AddLinkTeam

Configuration team UI:

ConfigurationTeam

Shared dashboard team:

SharedDashboardTeam

9. Project Structure

  • The sample contains 3 projects
    • Web - Exposes REST APIs (including Bot messaging endpoint) for clients to consume and contains ClientApp logic.
    • Domain - Contains the business logic to setup online meetings based on where the resource is shared.
    • Infrastructure - Fulfills Domain's dependencies. Example - resource service, card factory to prepare card etc. If you want to change AC, or connect to a resource service, this is where you would make the changes.

10. Basic Tests

  • You should be able to install the application to personal scope, group chats and Teams.
  • Share a link say https://<your_tunnel_domain>/dashboard1 and application should prompt the user to sign-in and unfurl it to an adaptive card post sign-in.
  • You should be able to open stage tab view from adaptive card.
  • You should be able to setup a meeting with everything configured.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading