Skip to content

Latest commit

 

History

History
page_type description products languages extensions urlFragment
sample
This app enables seamless integration with third-party cloud storage providers for files dragged and dropped in Teams chats or channels. It uses the Microsoft Teams JavaScript SDK's thirdPartyCloudStorage module to fetch and upload files efficiently.
office-teams
office
office-365
nodejs
contentType createdDate
samples
2024-12-26 17:00:25
officedev-microsoft-teams-samples-msgext-thirdparty-storage-nodejs

Third-Party Storage Integration in Microsoft Teams

Microsoft Teams allows users to integrate third-party cloud storage providers by modifying the default storage options from OneDrive and SharePoint. This capability enables files that are dragged and dropped into the Teams chat or message compose area to be stored in a third-party storage service. Using the Microsoft Teams JavaScript client library (TeamsJS), third-party apps can capture these files through the getDragAndDropFiles API and then upload them to their own cloud storage.

To enable this feature, the latest version of the TeamsJS SDK is required, along with a properly configured app manifest and the app ID of the third-party storage provider. When a file is dragged and dropped, it is temporarily cached in Teams before being fetched by the third-party app and uploaded to its storage. This seamless integration enhances flexibility for businesses using external storage solutions within the Teams environment.

Included Features

  • Message Extensions

Interaction with bot msgext-thirdparty-storage

Prerequisites

Run the app (Using Teams Toolkit for Visual Studio Code)

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

  1. Ensure you have downloaded and installed Visual Studio Code
  2. Install the Teams Toolkit extension
  3. Select File > Open Folder in VS Code and choose this samples directory from the repo
  4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
  5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
  6. In the browser that launches, select the Add button to install the app to Teams.

Setup

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  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

Setup for bot

In Azure portal, create a Azure Bot resource. - For bot handle, make up a name. - Select "Use existing app registration" (Create the app registration in Microsoft Entra ID beforehand.) - If you don't have an Azure account create an Azure free account here

In the new Azure Bot resource in the Portal, - Ensure that you've enabled the Teams Channel - In Settings/Configuration/Messaging endpoint, enter the current https URL you were given by running the tunnelling application. Append with the path /api/messages

Setup for code

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  2. In a terminal, navigate to samples/msgext-thirdparty-storage/nodejs

  3. Install modules

    npm install
  4. Update the .env configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (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.) MicrosoftAppTenantId will be the id for the tenant where application is registered.

    • Set "MicrosoftAppType" in the env. (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)

    • Set "BaseUrl" in the env as per your application like the ngrok forwarding url (ie https://xxxx.ngrok-free.app) after starting ngrok and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

  5. Run your bot at the command line:

    npm start
  6. 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 <<YOUR-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 bot 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

Upload an Application to Teams 1.UploadApp

Select the Build for Your Organization 2.BuildOrgApp

Log in to Admin Center and Copy App ID 3.AdminCenter

Admin Settings for File Drag-and-Drop to Third-Party Storage

4.AdminSettings

Install the Application in Teams 5.InstallApp

Select a Channel for File Upload 6.SelectChannelChat

Open the Channels to Access Files 7.OpenChannel

Drag and Drop All Files into Teams 8.drag_drop_all_file

Files Successfully Dragged and Dropped 9.drag_drop_files

All Files Loaded in Task Module 10.drag_drop_files_task_module

Files Loaded into the Compose Area 11.Upload_ComposeFile

Send All Dragged and Dropped Files 12.SendComposeFile

Drag and Drop Files in Chat 13.drag_drop_all_file_chat

Drop Files in the Chat Window 14.drag_drop_file_Chat

Load All Files in the Task Module 15.drag_drop_file_load_Task_module

Upload All Files in the Chat 16.UploadChat

Send Files in the Chat 17.SendChat

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