Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
page_type description products languages extensions urlFragment
sample
Microsoft Teams app localization using Bot and Tab
office-teams
office
office-365
csharp
contentType createdDate
samples
07/07/2021 01:38:25 PM
officedev-microsoft-teams-samples-app-localization-csharp

Teams App Localization

This sample illustrates how to implement Localization for Microsoft Teams apps.

Interaction with app.

Preview Image

Prerequisites

Verify you have the right account for building Teams apps and install some recommended development tools.

Setup

  1. 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.

  2. 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.
  3. Setup NGROK

    • Run ngrok - point to port 3978
    ngrok http -host-header=rewrite 3978
  4. 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:

  1. If you are using Visual Studio
  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to app-localization\csharp folder
  • Select Localization.csproj file
  1. This step is related to Microsoft Teams app manifest
    • Edit the manifest.json contained in the Manifest 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 the manifest.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 a manifest.zip
    • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

Running the sample

In Teams, Once the app is successfully installed, you can interact with tab and bot in your preferred language.

To change language in Teams

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.

  1. Installation: You should see your app installation screen content in selected language. image

  2. Bot: send any message to see localized image

  3. Tab: click on tab to see localized info.
    image

To Add more languages for localization in Teams through Code.

Add Resource files for the respective languages, Check culture fallback behaviour and how to add other cultures refer Globalization and localization Fundamentals.