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
This sample demos a bot with capability to upload files to SharePoint site and same files can be viewed in Teams file viewer.
office-teams
office
office-365
csharp
contentType createdDate
samples
11/16/2021 12:00:00 AM
officedev-microsoft-teams-samples-bot-sharepoint-file-viewer-csharp

Bot with SharePoint file to view in Teams file viewer

Using this C# sample, a bot with capability to upload files to SharePoint site and same files can be viewed in Teams file viewer

Included Features

  • Teams SSO (bots)
  • Adaptive Cards
  • Graph API

Interaction with bot

sharepoint-file-viewer

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.

  1. Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
  2. Install Teams Toolkit for Visual Studio Teams Toolkit extension
  3. 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.
  4. In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
  5. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
  6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
  7. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
  8. 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.

Setup

1. Setup for Bot SSO

Refer to Bot SSO Setup document.

2. Setup NGROK

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

3. Setup SharePoint Site.

  1. SharePoint site configuration

    • Login to sharepoint
    • Click on Create site and select Team site

    Team Site

    • Enter site name and description of site.

    Site name.

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

4. Setup for code

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 or BotWithSharePointFileViewer.slnfile

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 eg https://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.

5. Setup Manifest for Teams

  1. This step is specific to Teams.
    • Edit the manifest.json contained in the AppManifest 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 the manifest.json)
    • Edit the manifest.json for validDomains with base Url domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.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 a manifest.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)

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample

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.

  1. The viewfile command will list all the files that are uploaded to sharepoint site. View files

  2. The uploadfile command will return a card, which will open a task module from where new files can be uploaded to sharepoint. Upload file Upload file page Upload file page View files Files Open In Browser

  3. The files will be uploaded to sharepoint. File details

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading