/collab-stage

Primary LanguageTypeScript

Overview of the Link Unfurling app template

This template showcases an app that unfurls a link into an adaptive card when URLs with a particular domain are pasted into the compose message area in Microsoft Teams or email body in Outlook.

hero-image

Get Started with the Link Unfurling app

Prerequisites

  1. First, select the Teams Toolkit icon on the left in the VS Code toolbar.
  2. In the Account section, sign in with your Microsoft 365 account if you haven't already.
  3. Press F5 to start debugging which launches your app in Teams or Outlook using a web browser by select a target Microsoft application: Debug in Teams, Debug in Outlook and click the Run and Debug green arrow button.
  4. When Teams or Outlook launches in the browser, select the Add button in the dialog to install your app to Teams.
  5. Paste a link ending with .botframework.com into compose message area in Teams or email body in Outlook. You should see an adaptive card unfurled.

What's included in the template

Folder / File Contents
teamsapp.yml Main project file describes your application configuration and defines the set of actions to run in each lifecycle stages
teamsapp.local.yml This overrides teamsapp.yml with actions that enable local execution and debugging
.vscode/ VSCode files for local debug
src/ The source code for the link unfurling application
appPackage/ Templates for the Teams application manifest
infra/ Templates for provisioning Azure resources

The following files can be customized and demonstrate an example implementation to get you started.

File Contents
src/index.ts Application entry point and restify handlers
src/linkUnfurlingApp.ts The teams activity handler
src/adaptiveCards/helloWorldCard.json The adaptive card

Extend this template

This section introduces how to customize or extend this template, including: