Quickly develop apps with Teams App Studio (Preview)
Microsoft Teams is a chat-based workspace in Office 365 that integrates with the apps and services that people use to get work done together.
Microsoft Teams App Studio makes it easy to start creating or integrating your own service, whether you develop custom apps for your enterprise or SaaS applications for teams around the world.
Teams App Studio was created to simplify and streamline the process of creating real apps. It is much faster than the manual process described in Get started with Node.js: Teams App Studio is now the recommended way to develop Teams apps. The getting started documentation will be updated at a later date.
Apps for Teams are made up of two parts:
- The functionality of the app is hosted on a web server
- The definition of the app is contained in an application package that Teams uses to find and display your app functionality. The app package is what you upload to Teams when you first test your app
The most significant part of the application package is the app manifest.
Teams App Studio streamlines the creation of the manifest for your app, and also provides some useful tools like the Card Editor and a React control library. Writing and hosting the code is still up to you.
Installing App Studio
Teams App Studio is a Teams app which can be found in the Teams store. See the Store Icon in the left-hand ribbon of Teams, or follow this link for direct download: Teams App Studio.
In the store, search for Teams App Studio.
Select the Teams App Studio tile to open the app install page:
Once you are in Teams App Studio, click on the Manifest editor tab where you can either import an existing app or create a new app.
App Studio Features
This is where you can see what the cards you create in App Studio look like in Teams when you test them by sending them to yourself.
As mentioned earlier, the most significant part of a Microsoft Teams app package is its manifest.json file. This file, which must conform to the Teams App schema, contains metadata which allows Teams to correctly present your app to users.
The Manifest Editor tab in App Studio simplifies creating the manifest, allowing you to describe the app, upload your icons, add app capabilities, and produce a .zip file which can easily be uploaded into Teams for testing or distributed for others to use. Note that App Studio does not produce functional code for your app, or host your app. Your app must already be hosted and running at the URL listed in the manifest for the app upload process to result in a working app.
The capabilities section of the Manifest Editor is where the app's capabilities are defined and where details of each of those capabilities are listed.
Team Tabs. A team tab becomes part of a channel and provides a single kind of information to a team. For example, the Planner tab for a channel contains a single plan; the Power BI tab maps to a specific report. Users can drill down to the relevant context, but they should not be able to navigate outside the tab. The Power BI tab, for instance, doesn't enable navigation to other Power BI reports, but it does enable the Go to website button that launches the report in the main Power BI website.
For team tabs, you must provide a Configuration URL to present options and gather information so users can customize the content and experience of your tab. This iframed HTML page is displayed when a user first adds the tab to a channel.
You must also provide any additional domains that the tab expects to load from or link to.
Personal Tabs. This section lets you define a set of tabs that are presented by default in the one-on-one app experience (i.e. the experience a user has with your app outside the context of a team or channel). In this section, provide the tab name, a unique identifier, the URL that points to the UI to be displayed in Teams, and optionally, the URL to use if a user opts to view the tab in a browser. As with Teams tabs, provide any additional domains from which the tab expects to load from or link to.
This section allows you to add a bot to your app. Currently, an app can only have one bot. If you already have a bot registered with Bot Framework, you can add that bot by clicking Set Up and supplying the bot’s name, Bot Framework ID, and defining the scopes in which the bot will work.
If you have not yet registered a bot with the Bot Framework, click Register to create a new one. Once you’re done registering your bot, come back to this section of the Manifest Editor to enter its name and Bot Framework ID.
Once you have supplied your bot’s information, you can now optionally define a list of commands that your bot can suggest to users. Add the name of the command, a description of the command which indicates its syntax and arguments, and the scope(s) to which this command should apply.
Note that if you have defined your bot to only support one scope, commands specified for the unsupported scope will be ignored. You can edit the scopes your bot supports at any time.
This section allows you to add a connector to your app. If you already have registered an Office 365 connector, choose Set up and enter the name and ID of the connector. If you want a new connector click Register to be taken to the Connector Developer Dashboard in your browser.
Messaging extensions are a powerful new way for users to engage with your app within Microsoft Teams. Users can query for information from your service and post that information in the form of rich cards, right into the channel or chat conversation.
Messaging extensions are powered by Bot Framework bots, so they require a configured bot to operate. If you have the name and Bot Framework ID of the bot you would like to power the messaging extension, enter it. Otherwise, click Register to create one and enter the information afterward. Select whether the configuration of a messaging extension can be updated by the user.
Once you have the underlying bot configured, define the commands and parameters which the messaging extension can accept.
Each command requires a title and an ID. The command can optionally contain a description for the user. Each command can support up to five parameters, each of which requires:
- The name of the parameter as it appears in the Teams client and is included in the user request
- A user-friendly title
- An optional description
Test and Distribute
Once you have finished defining your application, the Test and Distribute section allows you export your app’s definition as a zip file which then can be shared and uploaded into the Teams client for testing. Clicking export downloads the zip file as appname.zip in your default download directory.
A card is a container for short or related pieces of information. Microsoft Teams supports rich cards, which can have multiple properties and attachments. Cards are a key way that bots and connectors relay actionable information to users.
To make this process easier and less error-prone, the Card Editor tab lets you build Hero Cards or Thumbnail Cards using a form and verify and test the resulting card (exactly as a user would see it) via a bot. It also provides the corresponding JSON, C#, or Node.js code for the card that you can copy/paste into your app's source code.
If you already have a card that you would like to verify inside Teams, you can paste the JSON for that card into the JSON tab under Add card info and send it to yourself to see what it looks like in a chat.
React Control Library
Creating an app that follows the Teams best practices is a great way to give your app a look and feel that fits seamlessly with the Teams client experience. The UI controls that you use are critical to achieving that end. In order to make it easier to create a consistent UI, App Studio provides several categories of UI controls which follow Teams design principles.
Examples of the controls and corresponding React components are provided and ready to use in building your app.
- Radio Buttons
- Test Areas
The control library is open source. It is found on GitHub.