Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
platform | Submission Checklist | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/concepts/deploy-and-publish/appsource/prepare/submission-checklist.md | Depending on your app functionality, you're required to provide Teams tenant con * Ensure that test accounts are safe-listed or configured with license keys, if applicable. * If your app requires users to log in or connect to external services, provide the required credentials to complete the login or connection with the external service.- * Ensure that phone-based 2-way authentication is disabled for test accounts. + * Ensure that phone-based two-way authentication is disabled for test accounts. * If the app provides a collaborative experience, provide a non-admin account for each user persona. For example, if your app is used by teachers and students, provide credentials for both user personas. * Ensure that at least one account has access to premium or upgraded features, if applicable. * All accounts you provide must include pre-populated data to help in testing. For example, if your app helps to provide market insights based on the user profile, ensure that market data is pre-populated along with a few user profiles. The long description can provide a narrative that highlights your apps: * The problems it solves * Target audience -While this description can be as long as 4,000 characters, most users will only read between 300-500 words. +While this description can be as long as 4,000 characters, most users only read between 300-500 words. :::row::: You can add a URL for your YouTube or Vimeo video. #### Best practices for videos * Keep your video between 60-90 seconds.-* Aim for quality. In a listing, users will see your video before screenshots. +* Aim for quality. In a listing, users see your video before screenshots. * Communicate the value of the product in narrative form. * Demonstrate how the product works. During submission, you're asked to categorize your app. You can categorize your If you want to cater your app to a specific audience, you can select from the available list of countries and communicate whatΓÇÖs great about your app in ways that are relevant to users. This is known as Geo-filtering. Geo-filtering is applicable only for apps listed in the Teams store. For example, a Contoso US app, which sells gift cards that are valid within the US and Canada is only visible in the Teams store for the users in the US and Canada. +# [Desktop](#tab/desktop) ++The following image shows the use of Geo-filtering for apps in the Teams desktop client: ++ :::image type="content" source="../../../../assets/images/app-fundamentals/geo-fencing-infographic.png" alt-text="Infographic shows the difference in the Teams Store for the apps available in the US and other countries." lightbox="../../../../assets/images/app-fundamentals/geo-fencing-infographic.png"::: ++# [Mobile](#tab/mobile) ++The following image shows the use of Geo-filtering for apps in the Teams mobile client: ++ :::image type="content" source="../../../../assets/images/app-fundamentals/mobile-infographic.png" alt-text="Infographic shows the difference in the Teams Store for the apps available in the US and other countries in mobile." ::: ++ > [!NOTE] > Geo-filtering isn't supported in Government community cloud (GCC), GCC-High, and Department of Defence (DoD) tenants. |
platform | Debug Background Process | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/toolkit/debug-background-process.md | Teams Toolkit checks the following prerequisites during the debugging process: * Teams Toolkit checks if Node.js is installed. If Node.js isn't installed, the debugging terminates. * Teams Toolkit checks if Node.js version matches the versions defined in `package.json` file. If the version doesn't match, Teams Toolkit displays a warning message in output channel. * Teams Toolkit prompts you to sign in to Microsoft 365 account, if you haven't signed in with your valid credentials.-* Teams Toolkit checks if custom app uploading or sideloading for your developer tenant is turned on. If it isn't turned on, the debugging terminates. -* Teams Toolkit checks if ports are available. If tab, bot, message extension, and Azure Functions ports are unavailable, the debugging terminates. +* Custom app uploading or sideloading for your developer tenant is turned on to prevent local debug termination. +* If Ngrok isn't installed or the version doesn't match the requirement, Teams Toolkit installs Ngrok npm package `ngrok@4.2.2` in `~/.fx/bin/ngrok`. Ngrok binary version 2.3 is applicable for bot and message extension and is managed by Ngrok npm package in `/.fx/bin/ngrok/node modules/ngrok/bin`. ++ > [!NOTE] + > Teams Toolkit project templates use the ngrok@4.3.3 npm package, which contains v2.3.40. For more information on how to get a valid license, see [ngrok](https://ngrok.com/). ++* If Azure Functions Core Tools version 4 isn't installed or the version doesn't match the requirement, Teams Toolkit installs Azure Functions Core Tools npm package `azure-functions-core-tools@3` for Windows and macOS in `~/.fx/bin/func`. The Azure Functions Core Tools npm package in `~/.fx/bin/func/node_modules/azure-functions-core-tools/bin` manages Azure Functions Core Tools binary. For Linux, the local debug terminates. +* If .NET Core SDK isn't installed or the version doesn't match the requirement, Teams Toolkit installs .NET Core SDK for Windows and macOS in `~/.fx/bin/dotnet`. .NET Core SDK version is applicable for Azure Functions. For Linux, the local debug terminates. ++ The following table lists the .NET Core versions: ++ | Platform | Software| + | | | + |Windows, macOS (x64), and Linux | **3.1 (recommended)**, 5.0, 6.0 | + |macOS (arm64) |6.0 | ++* If the development certificate for localhost isn't installed for tab in Windows or macOS, then Teams Toolkit prompts you to install it. +* If Azure Functions binding extensions isn't installed, then Teams Toolkit installs Azure Functions binding extensions in `api/extensions.csproj`. +* If npm packages aren't installed, then Teams Toolkit installs all npm packages applicable for tab app, bot app, message extension, and Azure Functions. +* Teams Toolkit starts Ngrok to create an HTTP tunnel for bot and message extension. +* If tab, bot, message extension, and Azure Functions ports aren't available, the local debug terminates. ++ The following table lists the ports available for components: ++ | Component | Port | + | | | + | Tab | 53000 | + | Bot or message extension | 3978 | + | Node inspector for bot or message extension | 9239 | + | Azure Functions | 7071 | + | Node inspector for Azure Functions | 9229 | ++<!-- The following table lists the limitations if the required software is unavailable for debugging: ++|Project type|Installation| Limitation| +|-|--|--| +|Tab without Azure functions | Node.js LTS versions 10, 12, **14 (recommended)**, 16 | The local debug terminates, if Node.js isn't installed or the version doesn't match the requirement.| +|Tab with Azure functions | Node.js LTS versions 10, 12, **14 (recommended)** |The local debug terminates, if Node.js isn't installed or the version doesn't match the requirement.| +|Bot | Node.js LTS versions 10, 12, **14 (recommended)**, 16|The local debug terminates, if Node.js isn't installed or the version doesn't match the requirement.| +|Message extension | Node.js LTS versions 10, 12, **14 (recommended)**, 16 |The local debug terminates, if Node.js isn't installed or the version doesn't match the requirement.| +|Sign-in to Microsoft 365 account | Microsoft 365 credentials |Teams Toolkit prompts you to sign-in to Microsoft 365 account, if you haven't signed in. | +|Bot, message extension | Ngrok version 2.3| ΓÇó If Ngrok isn't installed or the version doesn't match the requirement, the Teams Toolkit installs Ngrok NPM package `ngrok@4.2.2` in `~/.fx/bin/ngrok`. </br> ΓÇó The Ngrok binary is managed by Ngrok NPM package in `/.fx/bin/ngrok/node modules/ngrok/bin`.| +|Azure functions | Azure Functions Core Tools version 3| ΓÇó If Azure Functions Core Tools isn't installed or the version doesn't match the requirement, the Teams Toolkit installs Azure Functions Core Tools NPM package, azure-functions-core-tools@3 for **Windows** and for **macOs** in `~/.fx/bin/func`. </br> ΓÇó The Azure Functions Core Tools NPM package in `~/.fx/bin/func/node_modules/azure-functions-core-tools/bin` manages Azure Functions Core Tools binary. For Linux, the local debug terminates.| +|Azure functions |.NET Core SDK version|ΓÇó If .NET Core SDK isn't installed or the version doesn't match the requirement, the Toolkit installs .NET Core SDK for Windows and macOS in `~/.fx/bin/dotnet`.</br> ΓÇó For Linux, the local debug terminates.| +|Azure functions | Azure functions binding extensions defined in `api/extensions.csproj`| If Azure functions binding extensions isn't installed, the Toolkit installs Azure functions binding extensions.| +|NPM packages| NPM packages for tab app, bot app, message extension app, and Azure functions|If NPM isn't installed, the Toolkit installs all NPM packages.| +|Bot and message extension | Ngrok |Toolkit starts Ngrok to create a HTTP tunnel for bot and message extension. | ++> [!NOTE] +> If tab, bot, message extension, and Azure functions ports are unavailable, the local debug terminates. ++Use the following .NET Core versions: ++| Platform | Software| +| | | +|Windows, macOs (x64), Linux | **3.1 (recommended)**, 5.0, 6.0 | +|macOs (arm64) |6.0 | ++> [!NOTE] +> If the development certificate for localhost isn't installed for tab in Windows or MacOS, the Teams Toolkit prompts you to install it.</br> --> When you select **Start Debugging (F5)**, Teams Toolkit output channel displays the progress and result after checking the prerequisites. :::image type="content" source="../assets/images/teams-toolkit-v2/debug/prerequisites-debugcheck.png" alt-text="Screenshot shows the prerequisites check summary."::: -For more information on validating prerequisites, see [Validate prerequisites task](https://aka.ms/teamsfx-tasks/check-prerequisites). +For more information, see [validate prerequisites task](https://aka.ms/teamsfx-tasks/check-prerequisites). ## Start local tunnel -For bot and message extension, Teams Toolkit starts a local tunnel service to make the bot messaging endpoint public. For more information, see [Start local tunnel task](https://aka.ms/teamsfx-tasks/local-tunnel). +For bot and message extension, Teams Toolkit starts a local tunnel service to make the bot messaging endpoint public. For more information, see [start local tunnel task](https://aka.ms/teamsfx-tasks/local-tunnel). ## Create the debug resources |