Skip to content

Latest commit

 

History

History
279 lines (186 loc) · 12.1 KB

README.md

File metadata and controls

279 lines (186 loc) · 12.1 KB
Raw
page_type description products languages extensions urlFragment
sample
This sample shows how to interact with Calendar, Mail, Profile, geolocation from personal tabs app.
office-teams
office
office-365
typescript
contentType createdDate
samples
20/06/2023 01:38:27 PM
officedev-microsoft-teams-samples-tab-multi-hub-ts

Interact with Calendar, Mail, Profile, geolocation from Personal Tabs App

Interact with the user's calendar, mail, profile, geolocation from personal tabs app.

Included Features

  • Tabs
  • Outlook Calendar, Mail, Profile, geolocation

Interaction with app - Desktop

Tab Personal QuickstartGif

Interaction with app - Mobile

Tab Personal QuickstartGif

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.

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.

1. Register you app with Azure AD

  1. Register a new application in the Azure Active Directory – App Registrations portal.
  2. 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.
  3. 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 .env.
  4. Under Manage, select Expose an API.
  5. Select the Set link to generate the Application ID URI in the form of api://{base-url}/{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.
  6. Select the Add a scope button. In the panel that opens, enter access_as_user as the Scope name.
  7. Set Who can consent? to Admins and users
  8. 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.
  9. Ensure that State is set to Enabled
  10. 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.
  11. 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 desktop, mobile)
    • 5e3ce6c0-2b1f-4285-8d4b-75ee78787346 (Teams web)
    • 4765445b-32c6-49b0-83e6-1d93765276ca (Microsoft 365 web)
    • 0ec893e0-5785-4de6-99da-4ed124e5296c (Microsoft 365 desktop)
    • d3590ed6-52b3-4102-aeff-aad2292ab01c (Microsoft 365 mobile)
    • bc59ab01-8403-45c6-8796-ac3ef710b3e3 (Outlook web)
    • 27922004-5251-4030-b22d-91ecd9a37ea4 (Outlook mobile)
  12. 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)
    • Calendars.Read
    • Calendars.ReadBasic
    • Calendars.ReadWrite
  • Click on Add permissions. Please make sure to grant the admin consent for the required permissions.
  1. 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://{Base_Url}/auth-end.
  1. 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.

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

  2. Setup for code Clone the repository

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

  3. Open .env file from this path folder samples/tab-multi-hub/ts/api-server and update

    • {{CLIENT_ID}} - Generated from Step 1 (Application (client) ID)is the application app id
    • {{CLIENT_SECRET}} - Generated from Step 1.14, also referred to as Client secret

  4. Open .env file from this path folder samples/tab-multi-hub/ts and update

    • {{REACT_APP_AZURE_APP_REGISTRATION_ID}} - Generated from Step 1 (Application (client) ID)is the application app id
    • {{REACT_APP_BASE_URL}} - Your application's base url. E.g. https://12345.ngrok-free.app if you are using ngrok and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

  5. We have two different solutions to run, so follow below steps:

  • In a terminal, navigate to samples/tab-multi-hub/ts/api-server 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

  • The server will start running on 5000 port

  • In a different terminal, navigate to samples/tab-multi-hub/ts 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

  • The client will start running on 3978 port

3. Setup Manifest for Teams

  • This step is specific to Teams. Edit the manifest.json contained in the appManifest/ 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 {{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 Upload the manifest.zip to Teams (in the left-bottom Apps view, click "Upload a custom app")

Running the sample - Desktop

Add/upload the app in Microsoft Teams:

InstallApp

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

AppOutlook

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

HomeScreen

Add Details for Compose Meeting:

EnterComposeMeeting

Click ComposeMeeting:

ClickComposeMeeting

Click View:

ClickView

App In Outlook:

AppInOutlook

App In Outlook with input values:

AppInOutlookwithinputvalues

Compose Mail From Outlook Personal Tab:

ComposeMail

Profile UI:

ProfileUI

Enter any Email to get a profile card at a specified position to show profile information about that persona:

EnterEmail

User Profile Details:

ClickView

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:

EnterEmail

Select geo location tab:

EnterEmail

Click the button to get your current geolocation:

EnterEmail

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

Running the sample - Mobile

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

InstallApp

Select your app icon to launch and preview your app running in Outlook on the desktop and add details for Compose Meeting:

M1

Click ComposeMeeting:

M2

Calendar Tab UI:

M3

Email Tab UI:

M4

Compose Mail From Outlook Personal Tab:

M5

Profile Module:

M6

This app is currently not supported on this platform:

M6

Select geo location tab:

M6

Click the button to get your current geolocation:

M6

Further Reading.