page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
Microsoft Teams app localization using Bot and Tab |
|
|
|
officedev-microsoft-teams-samples-app-localization-csharp |
This sample illustrates how to implement Localization for Microsoft Teams apps.
Verify you have the right account for building Teams apps and install some recommended development tools.
- You need a Teams account that allows custom app sideloading.
- .NET Core SDK version 6.0
- ngrok or equivalent tunnelling solution
-
Register a new application in the Azure Active Directory – App Registrations portal.
NOTE: When you create your app registration, you will create an App ID and App password (Secret) - make sure you keep these for later.
-
Setup for Bot
- Also, register a bot with Azure Bot Service, following the instructions here
- Ensure that you've enabled the Teams Channel
- While registering the bot, use
https://<your_ngrok_url>/api/messages
as the messaging endpoint.
-
Setup NGROK
- Run ngrok - point to port 3978
ngrok http -host-header=rewrite 3978
-
Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
Modify the
/appsettings.json
and fill in the following details: -
{{MicrosoftAppId}}
- Generated from Step 1 while doing AAd app registration in Azure portal. -
{{ClientSecret}}
- Generated from Step 1, also referred to as Client secret -
Run the bot from a terminal or from Visual Studio:
- If you are using Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
app-localization\csharp
folder - Select
Localization.csproj
file
- This step is related to Microsoft Teams app manifest
- Edit the
manifest.json
contained in theManifest
folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string<<YOUR-MICROSOFT-APP-ID>>
and <> and for the contentUrl "<<1234.ngrok.io>>?culture={locale}" (depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Provide ngrok Url (turnnelling Url) in
manifest.json
for contentUrl in case of tabs and for messaging endpoint in case of bots if enabled. - Zip up the contents of the
teamsAppManifest
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the Apps view click "Upload a custom app")
- Edit the
In Teams, Once the app is successfully installed, you can interact with tab and bot in your preferred language.
To change the language in Microsoft Teams, please click your profile picture at the top of the app, then select Settings -> General and go to the Language section. Choose the preferred language and restart to apply the change. This sample supports en-US, fr-CA, hi-IN and es-MX.
Add Resource files for the respective languages, Check culture fallback behaviour and how to add other cultures refer Globalization and localization Fundamentals.