تحرير

مشاركة عبر

Configure default options for Teams app

  • مقالة

It’s common for an app to support multiple scenarios in Teams, but you might have designed it with a specific scope and capability in mind. For example, if your app is primarily for team or channel use, you can make sure that the first install option users see in the Microsoft Teams Store is Add to a team.

Screenshot shows the Add to a team option.

If your app's primary capability is a bot, you can also make the bot the default capability when a user installs your app to a team.

Configure your app's default install scope

Configure the default install scope for your app. You can set only one scope at a time. For more information, see app manifest.

To configure the default install scope in your app manifest:

  1. Open your app manifest and add the defaultInstallScope property.

  2. Set default install scope value as, either personal, team, groupchat, or meetings.

    "defaultInstallScope": "meetings",

Configure the default capability for shared scopes

Configure the default capability when your app is installed for a team, meeting, or groupchat. For more information, see app manifest.

Note

defaultGroupCapability provides the default capability that's added to the team, group chat, or meeting. Select a tab, bot, or connector as the default capability for your app, but you must ensure that you have provided the selected capability in your app definition.

To configure details in app manifest:

  1. Open your app manifest and add the defaultGroupCapability property to it.

  2. Set a value of team, groupchat, or meetings.

  3. For the selected group capability, the available group capabilities are, bot, tab, or connector.

    Note

    You can select only one default capability, bot, tab, or connector for the selected group capability.

    "defaultGroupCapability": {
    "team": "bot",
    "groupchat": "bot",
    "meetings": "tab"
}

Configure your app's default landing capability

You can configure the default landing capability for an app that supports both bot and tab capabilities in personal scope. Based on this configuration, the app opens either as a bot or a tab by default.

You can configure any one of the following:

Bot as default landing capability

Configure your app to open as a bot by default:

  1. Open your app manifest.

  2. Under bots property, define scopes as personal.

    "bots": [
    {
        "botId":"<botId>",
        "scopes": [
        "personal"
        ]

Note

Bot acts as the default landing capability if its scope is defined as personal, even if you don't specify entityId as conversations in staticTabs property.

The following example demonstrates opening an app with bot as default landing capability and how a user can transition to a tab:

Graphic shows the process of opening an app with bot as default landing capability.

Tab as default landing capability

Configure your app to open as a tab by default:

  1. Open your app manifest.
  2. Under staticTabs property:
    1. Add the tab properties as the first entry of the array. To define tab properties, see app manifest.
    2. Add the following properties:
      1. Define entityId as conversations.
      2. Define scopes as personal.

The following code snippet is an example for setting tab as the default landing capability:

"staticTabs": [
   {
       "entityId": "com.contoso.helloworld.hellotab",
       "name": "Hello Tab",
       "contentUrl": "https://p4p9bji0-7130.inc1.devtunnels.ms/hello",
       "scopes": [
           "personal"
       ]
   },
   {
       "entityId":"conversations",
        "scopes":[
           "personal"
        ]
   }
]

The following example demonstrates opening an app with tab as default landing capability and how a user can transition to a bot:

Graphic shows the process of opening an app with tab as default landing capability.

The staticTabs property is also used to pin personal tabs and reorder tabs. For more information, see app manifest.

Block apps by default for users until an admin approves

To enhance the user experience of a Teams app, at times, IT administrators must intervene before users use the app. For example, consider a help desk app created by Contoso Electronics for Teams. To ensure the app functions properly, Contoso Electronics wants customers to configure specific properties of the app first.

To ensure that IT admins perform the relevant tasks, developers can block an app for users until an admin allows the app. To block the app by default, set the defaultBlockUntilAdminAction property to true in the app manifest file. When the property is set to true, the status of the app in Teams admin center is Blocked by publisher in the Manage apps page.

Screenshot shows an app blocked by publisher.

The admins can do their due diligence about your app and they can read the app documentation that you provide before they allow their users to use your app. For example, the admins can purchase the required licenses and distribute the licenses before allowing users to use the app. To allow the app with Blocked by publisher status, an admin can select Allow in the Manage apps page in Teams admin center.

Screenshot shows the Allow option for the app blocked by publisher.

If you don't want your app to be blocked by default, update the defaultBlockUntilAdminAction setting to false and submit your updated app for publishing. After we publish the new version of your app, it's allowed by default.

Note

For custom apps built for your org, defaultBlockUntilAdminAction isn't supported. If you upload a custom app built for your organization with this property, the app isn't blocked.

Code sample

Sample name Description .NET Node.js Manifest
Hello world This sample demonstrates how to configure default landing capability for an app that supports both bot and tab capabilities in personal scope. View View View

Next step

Create your app package