page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample demos a bot with capability to upload files to SharePoint site and same files can be viewed in Teams file viewer. |
|
|
|
officedev-microsoft-teams-samples-bot-sharepoint-file-viewer-csharp |
Using this C# sample, a bot with capability to upload files to SharePoint site and same files can be viewed in Teams file viewer
- Teams SSO (bots)
- Adaptive Cards
- Graph API
-
.NET Core SDK version 6.0
# determine dotnet version dotnet --version
-
Publicly addressable https url or tunnel such as dev tunnel or ngrok latest version or Tunnel Relay
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.
- Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
- Install Teams Toolkit for Visual Studio Teams Toolkit extension
- In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel.
- In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
- In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
- Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
- In the browser that launches, select the Add button to install the app to Teams.
If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.
Refer to Bot SSO Setup document.
-
Run ngrok - point to port 3978
ngrok http 3978 --host-header="localhost:3978"
Alternatively, you can also use the
dev tunnels
. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:devtunnel host -p 3978 --allow-anonymous
-
SharePoint site configuration
- Login to sharepoint
- Click on
Create site
and selectTeam site
- Enter site name and description of site.
-
From site address eg: 'https://m365x357260.sharepoint.com/sites/SharePointTestSite'
m365x357260.sharepoint.com
- value is sharepoint tenant name.- Click on next. (optional step)Add aditional owner and member.
- Click on Finish.
1 Clone the repository
```bash
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
```
2 In a terminal, navigate to samples/bot-sharepoint-file-viewer/csharp/BotWithSharePointFileViewer
3 If you are using Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
samples/bot-sharepoint-file-viewer/csharp
folder - Select
BotWithSharePointFileViewer.csproj
orBotWithSharePointFileViewer.sln
file
4 Update the appsettings.json
configuration for the bot to use the MicrosoftAppId, MicrosoftAppPassword, MicrosoftAppTenantId and ConnectionName generated in Step 1 (Setup for Bot SSO). (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.)
ApplicationBaseUrl
will be your app's base url. For eghttps://xxxx.ngrok-free.app
if you are using Ngrok and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.SharePointTenantName
will be the tenant name generated in step 3.2.SharePointSiteName
will be the site name created in step 3.
5 Run your bot, either from Visual Studio with F5
or using dotnet run
in the appropriate folder.
- This step is specific to Teams.
- Edit the
manifest.json
contained in theAppManifest
folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string<<Microsoft-App-Id>>
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) - Edit the
manifest.json
forvalidDomains
with base Url domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.ngrok-free.app
and if you are using dev tunnels then your domain will be like:12345.devtunnels.ms
. - Zip up the contents of the
AppManifest
folder to create amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package) - Upload the
manifest.zip
to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.) - Add the app to personal/team/groupChat scope (Supported scopes)
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
You can interact with this bot in Teams by sending it a message, or selecting a command from the command list. The bot will respond to the following strings.
-
The
viewfile
command will list all the files that are uploaded to sharepoint site. -
The
uploadfile
command will return a card, which will open a task module from where new files can be uploaded to sharepoint.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.