Service | Microsoft Docs article | Related commit history on GitHub | Change details |
---|---|---|---|
platform | Share In Meeting | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/concepts/build-and-test/share-in-meeting.md | The query parameters for the app context are: * `appID`: This is the ID that can be obtained from the app manifest. * `appSharingUrl`: The URL, which needs to be shared on stage should be a valid domain defined in the app manifest. If the URL isn't a valid domain, an error dialog appears to provide the user with a description of the error. * `useMeetNow`: This includes a Boolean parameter that can be either true or false.- * **True**: When the `UseMeetNow` value is true and if there's no ongoing meeting, a new Meet now meeting will be initiated. When there's an ongoing meeting, this value will be ignored. + * **True**: When the `useMeetNow` value is true and if there's no ongoing meeting, a new Meet now meeting will be initiated. When there's an ongoing meeting, this value will be ignored. - * **False**: The default value of `UseMeetNow` is false, which means that when a deep link is shared to stage and there's no ongoing meeting, a calendar pop-up will appear. However, you can share directly during a meeting. + * **False**: The default value of `useMeetNow` is false, which means that when a deep link is shared to stage and there's no ongoing meeting, a calendar pop-up will appear. However, you can share directly during a meeting. Ensure that all the query parameters are properly URI encoded and the app context has to be encoded twice in the final URL. Following is an example: A deep link can be launched either from the Teams web or from the Teams desktop |Deep link|Format|Example| ||||- |To share the app and open Teams calendar, when `UseMeeetNow` is **false**, default.|`https://teams.microsoft.com/l/meeting-share?deeplinkId={deeplinkid}&fqdn={fqdn}}&lm=deeplink%22&appContext={encoded app context}`|`https://teams.microsoft.com/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Afalse%257D`| - |To share the app and initiate instant meeting, when `UseMeeetNow` is **true**.|`https://teams.microsoft.com/l/meeting-share?deeplinkId={deeplinkid}&fqdn={fqdn}}&lm=deeplink%22&appContext={encoded app context}`|`https://teams.microsoft.com/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Atrue%257D`| + |To share the app and open Teams calendar, when `useMeeetNow` is **false**, default.|`https://teams.microsoft.com/l/meeting-share?deeplinkId={deeplinkid}&fqdn={fqdn}}&lm=deeplink%22&appContext={encoded app context}`|`https://teams.microsoft.com/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Afalse%257D`| + |To share the app and initiate instant meeting, when `useMeeetNow` is **true**.|`https://teams.microsoft.com/l/meeting-share?deeplinkId={deeplinkid}&fqdn={fqdn}}&lm=deeplink%22&appContext={encoded app context}`|`https://teams.microsoft.com/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Atrue%257D`| * **Team desktop client**: Use the following format to launch a deep link from the Teams desktop client to share content on stage: A deep link can be launched either from the Teams web or from the Teams desktop |Deep link|Format|Example| ||||- |To share the app and open Teams calendar, when `UseMeeetNow` is **false**, default.|`msteams:/l/meeting-share? deeplinkId={deeplinkid}&fqdn={fqdn}&lm=deeplink%22&appContext={encoded app context}`|`msteams:/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Afalse%257D`| - |To share the app and initiate instant meeting, when `UseMeeetNow` is **true**.|`msteams:/l/meeting-share? deeplinkId={deeplinkid}&fqdn={fqdn}&lm=deeplink%22&appContext={encoded app context}`|`msteams:/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Atrue%257D`| + |To share the app and open Teams calendar, when `useMeeetNow` is **false**, default.|`msteams:/l/meeting-share? deeplinkId={deeplinkid}&fqdn={fqdn}&lm=deeplink%22&appContext={encoded app context}`|`msteams:/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Afalse%257D`| + |To share the app and initiate instant meeting, when `useMeeetNow` is **true**.|`msteams:/l/meeting-share? deeplinkId={deeplinkid}&fqdn={fqdn}&lm=deeplink%22&appContext={encoded app context}`|`msteams:/l/meeting-share?deeplinkId={sampleid}&fqdn=teams.microsoft.com&lm=deeplink%22&appContext=%257B%2522appSharingUrl%2522%253A%2522https%253A%252F%252Fteams.microsoft.com%252Fextensibility-apps%252Fmeetingapis%252Fview%2522%252C%2522appId%2522%253A%25229cc80a93-1d41-4bcb-8170-4b9ec9e29fbb%2522%252C%2522useMeetNow%2522%253Atrue%257D`| The query parameters are: |
platform | Prerequisites | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/m365-apps/prerequisites.md | For more information on Microsoft 365 release options, see [set up the Standard ### Desktop -You can preview Teams apps running in Outlook on Windows desktop by using a recent *Current Channel build*. Check if you have to [change the Microsoft 365 Apps update channel](/deployoffice/change-update-channels?WT.mc_id=M365-MVP-5002016) for your test tenant to install a Microsoft 365 Current Channel build. +You can preview Teams apps running in Outlook on Windows desktop by using a recent *Current Channel (Preview)* build. Check if you have to [change the Microsoft 365 Apps update channel](/deployoffice/change-update-channels?WT.mc_id=M365-MVP-5002016) for your test tenant to install a Microsoft 365 Current Channel (Preview) build. To install Microsoft 365 applications in your test environment: 1. Sign in to your test environment with your test tenant credentials. 1. Download and run the [Office Deployment Tool](https://www.microsoft.com/download/details.aspx?id=49117). 1. Select a local folder to store the extracted files.-1. Go to the local folder and open *configuration-Office365-x86.xml* (or **x64.xml*, depending on your environment) in a text editor and ensure the *Channel* value is `Current`. +1. Go to the local folder and open *configuration-Office365-x86.xml* (or **x64.xml*, depending on your environment) in a text editor and ensure the *Channel* value is `CurrentPreview`. 1. Open Command Prompt and go to the local folder path. 1. Run `setup.exe /configure configuration-Office365-x86.xml` (or use the **x64.xml* file, depending on your setup). 1. Open Outlook (desktop client) and set up the mail account using your test tenant credentials.-1. Open **File** > **Office Account** > **About Outlook** to confirm you're running a Microsoft 365 *Current Channel* build of Outlook. -- :::image type="content" source="images/outlook-about-current-channel.png" alt-text="The screenshot shows where to verify you're running a Current Channel build in Outlook."::: +1. Open **File** > **Office Account** > **About Outlook** to confirm you're running a Microsoft 365 *Current Channel (Preview)* build of Outlook. 1. Verify that *Microsoft Edge WebView2 Runtime* is installed. Open Windows **Start** > **Apps & features**, and search for **webview**: |
platform | Promote App Adoption | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/promote-app-adoption.md | If you're a Microsoft Partner, you can work with your Microsoft counterpart to f Ensure that the users have access to and appropriate licenses for your app on Teams. There are two types of apps available for your users: * **Custom apps**: Custom apps are developed specifically for an organization and are made available by admins in Teams within their organization.-* **Third-party apps**: Teams store provides many useful apps created by third-party software developers in addition to apps created by Microsoft. For the apps created by third-party providers, Microsoft does rigorous validation of functionality and security. For more information, see [Understand third-party apps in Microsoft Teams](/microsoftteams/overview-third-party-apps). +* **Third-party apps**: [Teams apps in AppSource](https://appsource.microsoft.com/marketplace/apps?product=office%3Bteams) are created by third-party software developers and by Microsoft. For the apps created by third-party providers, Microsoft does testing and validation. For more information, see [Understand third-party apps in Microsoft Teams](/microsoftteams/overview-third-party-apps). Admins can set up an app governance process that manages your organization's IT policies, standards, and risk profiles. For more information. For more information, see [Create policies for app access](#create-policies-to-give-permission-to-use-apps-and-pin-it). To learn and understand how an IT admin can configure your app, see [Help IT adm Provide a user guide for your app and cover the following articles: -* Installation instructions for your app from the Teams store. +* Instructions to install your app from the [Microsoft Teams store](https://appsource.microsoft.com/marketplace/apps?product=office%3Bteams). * Key features and use cases of your app. For more information, see [Provide your app's use cases](#provide-a-feature-guide-for-the-users-of-your-app). * How can users reach you for support? * What are the user configuration settings, for example, profile setup? If your app accesses any data outside Teams, it does that using Microsoft Graph ### Buy and manage licenses and subscriptions for paid apps -Your app might require purchasing a service subscription to experience the app's full functionality and scope. These service subscriptions are called Software as a Service (SaaS) offers. A license can be made available for purchase through [AppSource](https://appsource.microsoft.com/) and through the [Teams admin center](https://admin.teams.microsoft.com/). Include instructions on buying and managing licenses, as part of your appΓÇÖs admin documentation. The governance controls for admins on paid and free apps remain the same. Admins can purchase apps using a credit card, debit card, or with invoice billing. To learn more about licenses and subscriptions, see [how admins manage subscriptions for apps](/microsoftteams/purchase-third-party-apps). +Your app might require purchasing a service subscription to experience the app's full functionality and scope. These service subscriptions are called Software as a Service (SaaS) offers. A license can be made available for purchase through [Microsoft AppSource](https://appsource.microsoft.com/) and through the [Teams admin center](https://admin.teams.microsoft.com/). Include instructions on buying and managing licenses, as part of your appΓÇÖs admin documentation. The governance controls for admins on paid and free apps remain the same. Admins can purchase apps using a credit card, debit card, or with invoice billing. To learn more about licenses and subscriptions, see [how admins manage subscriptions for apps](/microsoftteams/purchase-third-party-apps). ### Allow custom apps in an organization If an organization uses custom or line-of-business apps, then understand how adm Microsoft Teams admins can modify the metadata and appearance of some Teams apps to provide a personalized brand experience within their organization. Such modifications help admins adhere to their organization's requirements and branding. Customizing also enhances Teams store experience for the users, improves trust, and promotes app usage. For more information, see [how admins use app customization to update branding](/microsoftteams/customize-apps). -To support app customization, you as an app developer can allow admins to customize you app within their organization. Your app in Teams app store contains the default information and metadata that you provide when you create and submit an app. Teams provides an option to customize properties of an app. You can decide what properties of your app can the admins customize. However, customizations made within an organization don't affect the apps used in other organizations. To learn more, see [how to allow app customization](concepts/design/enable-app-customization.md). +To support app customization, you as an app developer can allow admins to customize you app within their organization. Your app in Teams store contains the default information and metadata that you provide when you create and submit an app. Teams provides an option to customize properties of an app. You can decide what properties of your app can the admins customize. However, customizations made within an organization don't affect the apps used in other organizations. To learn more, see [how to allow app customization](concepts/design/enable-app-customization.md). ### Documentation requirements for IT admins Provide the users with guides that help them understand how to use your app, tro ### Promote awareness about your app and its use cases for smooth change management -The adoption change management relies on awareness and training targeted at your customers. These are the marketing and communications segments of your overall app adoption strategy that make change management successful and smooth. It ensures that your users are aware of the new capabilities of the Teams app and it enables the users to derive value out of your app. +The adoption change management relies on awareness and trainings targeted at your customers. These trainings are the marketing and communication segments of your overall app adoption strategy that make change management successful and smooth. It ensures that your users are aware of the new capabilities of the Teams app and it enables the users to derive value out of your app. -For both initial pilots and eventual company-wide roll out, your internal communications must be a priority. These must include: +For both initial pilots and eventual company-wide roll out, your internal communications must be a priority. These communications must include: * Internal awareness materials such as posters, email templates, digital signage, and webinar or events. * Campaigns: Educate users about the benefits of using the Teams app. Use the template provided by Microsoft to create campaigns to improve organization-level awareness for apps. For both initial pilots and eventual company-wide roll out, your internal commun Microsoft provides few templates that you can use to speed up the adoption of your app. These templates help you quickly generate toolkit to popularize your app. See [Launch your collaborative apps](/microsoftteams/platform/concepts/deploy-and-publish/appsource/post-publish/app-growth/launch-app) for a list of resources and BOM assets that you should create for app launch. Register for [Microsoft ISV Success program](https://www.microsoft.com/isv/program-benefits) to receive guidance and templates for some of the above digital assets. -Microsoft provides a few templates that you can use to speed up the adoption of your app. These templates help you quickly generate toolkit to popularize your app. Register for to receive guidance and templates for some of the above digital assets. - The following considerations might help you make the awareness documents more user-friendly: * Include a call to action encouraging users to download and use the app. * Ensure that thereΓÇÖs a support path for users to contact the support team if they run into any problems.-* Your feature and usage guide must cover the details of how users can install the app from the Teams app store from different entry points such as channels, chats, meetings, and message extensions, as well as the details of each feature's usage. +* Your feature and usage guide must cover the details of how users can install the app from the [Teams store](https://appsource.microsoft.com/marketplace/apps?product=office%3Bteams) from different entry points such as channels, chats, meetings, and message extensions, as well as the details of each feature's usage. ### Provide training and create champions who facilitate change management In your appΓÇÖs help documentation, consider providing some or all the following * Call out any app-specific configuration or permissions that might be required. Also, call out any app-specific uptime information link if your app relies on a backend infrastructure to work. * If you [block an app by default](concepts/design/enable-app-customization.md), provide documentation for the requirements before admins can allow the app. For example, the required configuration or subscription purchase that admins must do. -The following table provides the support information that you already submitted to Microsoft with your app and the interface in Teams where this information is displayed. Your customers can find the above support information and self-serve themselves. +Your customers can find [support information for your app](/microsoftteams/manage-apps#support-information-for-apps) and self-serve themselves. The following table provides the support information that you already submitted to Microsoft with your app and the interface in Teams where this information is displayed: |Input source when creating app|Parameter|Description and meaning|Visibility of the information in Teams| |--|--|--|--| |[Manifest file](resources/schem)|`websiteUrl`|The web page at this URL provides support information for an app.|App details page in Teams admin center displays the website URL.|-|[Manifest file](resources/schem)|`privacyUrl`|The URL to the page that provides privacy information for the app.|ΓÇó Displayed in app details page in Teams admin center. <br> ΓÇó Displayed in Store listing.| -|[Manifest file](resources/schem)|`termsOfUseUrl`|The URL to the page that provides the terms of use for the app.|ΓÇó Displayed in app details page in Teams admin center. <br> ΓÇó Displayed in Store listing.| -|[Manifest file](resources/schem)|`publisherDocsUrl`|The URL to the page provides more app information for the admins.|Available in Teams admin center for apps that are blocked by publisher.| -|[Partner Center submission](/azure/marketplace/add-in-submission-guide)|NA|Support or help documentation URL.|Displayed in [AppSource](https://appsource.microsoft.com/), in the **Details + support** tab.| +|[Manifest file](resources/schem)|`privacyUrl`|The URL to the page that provides privacy information for the app.|ΓÇó Displayed in app details page in Teams admin center. <br> ΓÇó Displayed in Appsource listing.| +|[Manifest file](resources/schem)|`termsOfUseUrl`|The URL to the page that provides the terms of use for the app.|ΓÇó Displayed in app details page in Teams admin center. <br> ΓÇó Displayed in Appsource listing.| +|[Manifest file](resources/schem)|`publisherDocsUrl`|The URL destination provides app documentation for the admins to use to understand, allow, configure, and rollout the app. | URL is available in Teams admin center for those apps where app developer provide it in their manifest file.| +|[Partner Center submission](/azure/marketplace/add-in-submission-guide)|NA|Support or help documentation URL.|Displayed in [Microsoft AppSource](https://appsource.microsoft.com/), in the **Details + support** tab.| > [!div class="nextstepaction"] > [Back to top](#understand-how-you-can-drive-app-adoption) ## Step 5: Track app adoption and usage using analytics -You build an app for millions of Teams users to achieve specific business or customer goals. For this purpose, you distribute it using the options available on the app store versus a custom app. After the app is published, you'll want to measure how your app is performing in the real-world. YouΓÇÖd also want to guide the admins to measure their org-specific app usage. +You build an app for millions of Teams users to achieve specific business or customer goals. For this purpose, you distribute it using the options available on the Teams store versus a custom app. After the app is published, you'll want to measure how your app is performing in the real-world. YouΓÇÖd also want to guide the admins to measure their org-specific app usage. ### Track app usage in Partner Center -You can track your appΓÇÖs overall usage in [Teams app usage report](concepts/deploy-and-publish/appsource/post-publish/overview.md) in Partner Center. You can do this after a week of publishing your app on the Teams public app store. Partner Center's usage report provides standard metrics that enable you to track user demand, user churn, and frequency of usage for your app. These reports are available at an aggregate level, such as: +You can track your appΓÇÖs overall usage in [Teams app usage report](concepts/deploy-and-publish/appsource/post-publish/overview.md) in Partner Center after one week of publishing your app on the Teams store. Partner Center's usage report provides standard metrics that enable you to track user demand, user churn, and frequency of usage for your app. The reports are available at an aggregate level, such as: * Monthly, daily, and weekly active users. * Retention and intensity charts. |
platform | Install Teams Toolkit | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/toolkit/install-Teams-Toolkit.md | By default, Visual Studio Code automatically keeps Teams Toolkit up-to-date. If Teams Toolkit installs the version youΓÇÖve selected. +## Install a pre-release version ++The Teams Toolkit for Visual Studio Code extension is available in a pre-release version. To install a Teams Toolkit pre-release version, follow these steps: ++1. Open **Visual Studio Code**. +1. Select **Extensions** :::image type="icon" source="../assets/images/teams-toolkit-v2/teams toolkit fundamentals/extension icon.png" border="false" alt-text="Screenshot shows the extension icon."::: from the Visual Studio Code activity bar. +1. Enter **Teams Toolkit** in the search box. +1. On the Teams Toolkit page, select the dropdown arrow next to **Install**. +1. Select **Install Pre-Release Version**. + ## Next step > [!div class="nextstepaction"] |