page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
This sample demonstrates how to manage the lifecycle of channels in Microsoft Teams using the Graph API with Node.js. |
|
|
|
officedev-microsoft-teams-samples-graph-channel-lifecycle-nodejs |
This sample application illustrates the complete lifecycle of channels in Microsoft Teams, leveraging the Graph API to enable creating, updating, and deleting channels. Developed with Node.js, it includes features like tab integration and RSC permissions, along with detailed setup instructions for registration, tunneling, and deployment using the Teams Toolkit for Visual Studio Code.
- Tabs
- Graph API
- RSC Permissions
- Microsoft Teams is installed and you have an account (not a guest account)
- To test locally, NodeJS must be installed on your development machine (version 16.14.2 or higher)
- dev tunnel or ngrok latest version or equivalent tunneling solution
- M365 developer account or access to a Teams account with the
- Teams Toolkit for VS Code or TeamsFx CLI
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- 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 app in a Teams web client.
- 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.
- Register a new application in the Microsoft Entra ID – App Registrations portal.
- Your app must be registered in the Azure AD portal to integrate with the Microsoft identity platform and call Microsoft Graph APIs. See Register an application with the Microsoft identity platform. NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.
- Setup NGROK
-
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 code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In a terminal, navigate to `samples/graph-channel-lifecycle/nodejs
-
Update the
.env
configuration with the MicrosoftClientId
andClientSecret
-
Install modules
npm install
-
Run your bot at the command line:
npm start
- Setup Manifest for Teams
- This step is specific to Teams.
-
Edit the
manifest.json
contained in theappManifest/
folder to replace with your MicrosoftAppId (that was created in step1.1 and is the same value of MicrosoftAppId in.env
file) everywhere you see the place holder string{MicrosoftAppId}
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
) -
Zip up the contents of the
appManifest/
folder to create amanifest.zip
-
Upload the
manifest.zip
to Teams (in the left-bottom Apps view, click "Upload a custom app")
-