Skip to content

Latest commit

 

History

History
205 lines (152 loc) · 9.52 KB

README.md

File metadata and controls

205 lines (152 loc) · 9.52 KB
Raw
page_type description products languages extensions urlFragment
sample
This sample illustrates how you can use Teams App Chat Life Cycle by calling Microsoft Graph APIs through teams tab.
office-teams
office
office-365
nodejs
contentType createdDate
samples
07/07/2021 01:38:26 PM
officedev-microsoft-teams-samples-graph-chat-lifecycle-nodejs

ChatLifecycle Application

This sample illustrates Lifecycle of chat in Teams (Creating chat, adding members with all scenarios, deleting member).

Included Features

  • Tabs
  • Adaptive Cards
  • Graph API

Interaction with app

Prerequisites

  • 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)
  • ngrok or equivalent tunneling solution
  • M365 developer account or access to a Teams account with the

Setup

  • Ensure that you've enabled the Teams Channel NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.
  1. Register a new application in the Azure Active Directory – App Registrations portal.

  • Select New Registration and on the register an application page, set following values:

    • Set name to your app name.
    • Choose the supported account types (any account type will work)
    • Leave Redirect URI empty.
    • Choose Register.

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

  • Under Manage, select Expose an API.

  • Select the Set link to generate the Application ID URI in the form of api://{AppID}. Insert your fully qualified domain name (with a forward slash "/" appended to the end) between the double forward slashes and the GUID. The entire ID should have the form of: api://fully-qualified-domain-name/{AppID}

    • ex: api://%ngrokDomain%.ngrok-free.app/00000000-0000-0000-0000-000000000000.

  • Select the Add a scope button. In the panel that opens, enter access_as_user as the Scope name.

  • Set Who can consent? to Admins and users

  • Fill in the fields for configuring the admin and user consent prompts with values that are appropriate for the access_as_user scope: * Admin consent title: Teams can access the user’s profile. * Admin consent description: Allows Teams to call the app’s web APIs as the current user. * User consent title: Teams can access the user profile and make requests on the user's behalf. * User consent description: Enable Teams to call this app’s APIs with the same rights as the user. - Ensure that State is set to Enabled -. Select Add scope * The domain part of the Scope name displayed just below the text field should automatically match the Application ID URI set in the previous step, with /access_as_user appended to the end:

    • `api://[ngrokDomain].ngrok-free.app/00000000-0000-0000-0000-000000000000/access_as_user.

  • In the Authorized client applications section, identify the applications that you want to authorize for your app’s web application. Each of the following IDs needs to be entered:

    • 1fec8e78-bce4-4aaf-ab1b-5451cc387264 (Teams mobile/desktop application)
    • 5e3ce6c0-2b1f-4285-8d4b-75ee78787346 (Teams web application)

  • Note If you want to test or extend your Teams apps across Office and Outlook, kindly add below client application identifiers while doing Azure AD app registration in your tenant:

    • 4765445b-32c6-49b0-83e6-1d93765276ca (Office web)
    • 0ec893e0-5785-4de6-99da-4ed124e5296c (Office desktop)
    • bc59ab01-8403-45c6-8796-ac3ef710b3e3 (Outlook web)
    • d3590ed6-52b3-4102-aeff-aad2292ab01c (Outlook desktop)

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

  • Select Add a permission

  •  Select Microsoft Graph -> Delegated permissions.

    • User.Read (enabled by default)
    • email
    • offline_access
    • OpenId
    • profile
    • Chat.Create
    • Chat.ReadWrite
    • ChatMember.ReadWrite
    • TeamsAppInstallation.ReadWriteForChat
    • TeamsAppInstallation.ReadWriteSelfForChat
    • TeamsTab.Create
    • TeamsTab.ReadWriteForChat
    • TeamsTab.ReadWrite.All
    • User.Read.All

  • Click on Add permissions.

  • Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app. Set a redirect URI:

    • Select Add a platform.
    • Select Single Page Application.
    • Enter the redirect URI for the app in the following format: https://%ngrokDomain%.ngrok-free.app/auth/auth-end.

  • 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 appsettings.json.

  1. Setup NGROK

  • Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"
  1. Setup for code

  • Clone the repository

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

  • In a terminal, navigate to samples/graph-chat-lifecycle/nodejs

    cd samples/graph-chat-lifecycle/nodejs

  • Update your config/default.json file

    • Replace the YOUR-MICROSOFT-APP-ID property with you Azure AD application ID.
    • Replace the YOUR-MICROSOFT-APP-PASSWORD property with the "client secret" you were assigned.

  • Install modules

    npm install

  • Start the bot

    npm start

If you are using Visual Studio code

  • Launch Visual Studio code
  • Folder -> Open -> Project/Solution
  • Navigate to samples\graph-chat-lifecycle\nodejs folder
  • Select graph-chat-lifecycle\nodejs Folder
  1. This step is specific to Teams.
    • Edit the manifest.json contained in the graph-chat-lifecycle\nodejs\src\Manifest folder in src 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). Also, replace your Base url wherever you see the place holder string <<YOUR-BASE-URL>>. Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the manifest.json in the graph-chat-lifecycle\nodejs\src\Manifest_Hub folder with the required values.
    • Zip up the contents of the Manifest folder to create a Manifest.zip or Manifest_Hub folder to create a Manifest_Hub.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")

Running the sample

  1. In Teams, Install App

  1. In Teams, Once the app is successfully installed, it can be opened in the tab and has option to create group chat if user is authenticated.

  1. Once create group chat is clicked, user will be able to add Title of the groupchat and select users from drop down to create a group chat and add members (using different scenarios) and delete member accordingly to depict the lifecycle of chat.

  2. Also, Polly app will be installed to the created group chat and will be pinned to the chat.

Outlook on the web

  • To view your app in Outlook on the web.

  • Go to Outlook on the weband sign in using your dev tenant account.

On the side bar, select More Apps. Your sideloaded app title appears among your installed apps

InstallOutlook

Select your app icon to launch and preview your app running in Outlook on the web

AppOutlook

Note: Similarly, you can test your application in the Outlook desktop app as well.

Office on the web

  • To preview your app running in Office on the web.

  • Log into office.com with test tenant credentials

Select the Apps icon on the side bar. Your sideloaded app title appears among your installed apps

InstallOffice

Select your app icon to launch your app in Office on the web

AppOffice

Note: Similarly, you can test your application in the Office 365 desktop app as well.

Further Reading

Graph-Chat-Life-Cycle Extend Teams apps across Microsoft 365