Skip to content

Latest commit

 

History

History
 
 

nodejs

README.md

page_type description products languages extensions urlFragment
sample
This is a sample application which demonstrates how to use CRUD Graph operations within tab related to team tags.
office-teams
office
office-365
nodejs
contentType createdDate
samples
02/08/2022 12:02:15 AM
officedev-microsoft-teams-samples-graph-teams-tag-nodejs

Graph teams tag

This is a sample application where user can create, update, add or remove members of a tag. All of Graph CRUD operations related to tags can be performed within this sample.

Included Features

  • Teams SSO (tabs)
  • Graph API
  • Teamwork Tags

Interaction with app

  • Create new tags.

Create new tag

  • View/Edit existing tags.

View/Edit tag

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

Register your application with Azure AD

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.

  • On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the appsettings.json.

  • Navigate to API Permissions, and make sure to add the follow permissions:

    • Select Add a permission
    •  Select Microsoft Graph -> Application permissions.
    • TeamworkTag.ReadWrite.All

  • Click on Add permissions. Please make sure to grant the admin consent for the required permissions.

  • Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the .env file.

  1. Setup for Bot

NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.

  1. 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
  1. Setup for code

  • Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

  • Update the .env configuration for the bot to use the MicrosoftAppId, MicrosoftAppPassword and MicrosoftAppTenantId. (Note the MicrosoftAppId is the AppId created in step 1 (Setup for Bot), the MicrosoftAppPassword is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.) MicrosoftAppTenantId created in step 1 (Setup for Bot), the MicrosoftAppTenantId is referred to as the "Directory (tenant) ID"

  • Navigate to project In the folder where repository is cloned navigate to samples/graph-teams-tag/nodejs

  • Install node modules and run server

    Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same in Visual studio code terminal by opening the project in Visual studio code

    npm install
    npm start
    • Install node modules and run client

    Navigate to client folder, Open your local terminal and run the below command to install node modules. You can do the same in Visual studio code terminal by opening the project in Visual studio code

     cd client
 npm install
     npm start
  1. Setup Manifest for Teams

  • 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 app registration 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 and replace {{domain-name}} with base Url of your 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 the Apps view click "Upload a custom app")

    • Go to Microsoft Teams. From the lower left corner, select Apps
    • From the lower left corner, choose Upload a custom App
    • Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
    • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

Running the sample

  1. User can see list of tags created for the current team. Manage Tag Dashboard
  2. User can view/edit the existing team tags. View/Edit Tags
  3. User can create new team tags. Create new Tag
  4. User can delete existing team tags.

Further reading