DEV Community: Dev365

What details can be accessed via Teams context

Dev365 — Thu, 11 Feb 2021 08:20:25 +0000

When you are building a Microsoft Teams Tap app, you might want to know what kind of information are exposed via the teams context.

Context details are revealed about some user, team and company information. following code foreach context properties that is taken from personal tab app

Object.keys(microsoftTeams.context).forEach(key => { //... });

locale: en-us
theme: default
entityId: personal-tab-entityId
subEntityId:
isFullScreen: false
sessionId: 6a9040ee-3e75-b7b1-1c34-b33cb38e4c22
chatId:
meetingId:
hostClientType: web
tenantSKU: unknown
jsonTabUrl: microsoft-teams-json-tab.azurewebsites.net
userLicenseType: Unknown
appSessionId: c94922f8-6cfb-425a-9675-034631329eae
isMultiWindow: false
appIconPosition: 303
frameContext: content
teamSiteDomain: abc.sharepoint.com
teamSitePath:
teamSiteUrl:
ringId: general
tid: 22235f37-6421-4209-a601-aad98974a222
loginHint: admin@abc.onmicrosoft.com
upn: admi@abc.onmicrosoft.com
userPrincipalName: admin@abc.onmicrosoft.com
userObjectId: 226ca1c0-2108-4be7-955b-90f39abdcc22

more details can be found here
https://docs.microsoft.com/en-us/microsoftteams/platform/tabs/how-to/access-teams-context#getting-context-by-inserting-url-placeholder-values

IdentityServer4 from the scratch - Part 1

Dev365 — Tue, 26 Jan 2021 10:58:20 +0000

Why IdentityServer

if you have number of applications, but you need to Centralized login logic and workflow for all of your applications (web, native, mobile, services). IdentityServer might be your solution. It also enable Single sign capability . IdentityServer4 is an officially certified implementation of OpenID Connect.

Creating IdentityServer4 project

Simplest way to create an identity server instance is to use dotnet template. dotnet template can be installed as below

dotnet new-i identityserver4.template

but in this IdentityServer4 post series, lets starts from scratch

Create an empty web project based on net core using command prompt

dotnet new web

This project is nothing much more than program cs file and a startup cs files & it will run on port 5443 for https and 5000 for http

IdentityServer4 nuget package can be added to this project using following commands

dotnet add package IdentityServer4 --version 4.1.1

go into startup.cs to configure identity server and services code in ConfigureServices
It has been configured to empty list of Clients, IdentityResources, ApiScopes, ApiResources and Users for now.

AddDeveloperSigningCredential() is added here(Dev mode only) because various things in the tokens that identity server delivers for us needs to be signed and this developer signing credential
provides that signing material.

Add identity server into the pipeline
Remember the identity server is a piece of middleware

we're now ready to go now at the moment we have no apis defined. we have no clients defined and we have no users
defined but we can still run this.
Application runs at the moment we have no controllers and
viewers here so it's simply printing out hello world.👋

if you run

dotnet run

Our identityserver will run 0n https://localhost:5001

Also open-id-connect discovery document can be found here

https://localhost:5001/.well-known/openid-configuration

{
  "issuer": "https://localhost:5001",
  "jwks_uri": "https://localhost:5001/.well-known/openid-configuration/jwks",
  "authorization_endpoint": "https://localhost:5001/connect/authorize",
  "token_endpoint": "https://localhost:5001/connect/token",
  "userinfo_endpoint": "https://localhost:5001/connect/userinfo",
  "end_session_endpoint": "https://localhost:5001/connect/endsession",
  "check_session_iframe": "https://localhost:5001/connect/checksession",
  "revocation_endpoint": "https://localhost:5001/connect/revocation",
  "introspection_endpoint": "https://localhost:5001/connect/introspect",
  "device_authorization_endpoint": "https://localhost:5001/connect/deviceauthorization",
  "frontchannel_logout_supported": true,
  "frontchannel_logout_session_supported": true,
  "backchannel_logout_supported": true,
  "backchannel_logout_session_supported": true,
  "scopes_supported": [
    "offline_access"
  ],
  "claims_supported": [],
  "grant_types_supported": [
    "authorization_code",
    "client_credentials",
    "refresh_token",
    "implicit",
    "password",
    "urn:ietf:params:oauth:grant-type:device_code"
  ],
  "response_types_supported": [
    "code",
    "token",
    "id_token",
    "id_token token",
    "code id_token",
    "code token",
    "code id_token token"
  ],
  "response_modes_supported": [
    "form_post",
    "query",
    "fragment"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_basic",
    "client_secret_post"
  ],
  "id_token_signing_alg_values_supported": [
    "RS256"
  ],
  "subject_types_supported": [
    "public"
  ],
  "code_challenge_methods_supported": [
    "plain",
    "S256"
  ],
  "request_parameter_supported": true
}

If you look carefully at discover endpoint, There's some defaults values for grant types and
default response types but notice there are no
claims here yet and the only supported scope is offline access

In next post , we will see how our scopes, claims, resources ,clients are changed

Persist state and settings in Microsoft office add-ins

Dev365 — Thu, 29 Oct 2020 13:30:10 +0000

The Office JavaScript API provides objects for your add-in to save state across user sessions.
Office js api provides following objects to save state according to user sessions

Office.CustomProperties

Office.CustomXmlParts

Office.RoamingSettings

Office.Settings

Settings office api object is used to store data on the document, workbook, or presentation
CustomXmlParts object is used to store data in a custom XML part of the document or workbook.
CustomProperties and RoamingSettings office api objects are supported MailApp add-ins.data is stored as Data is stored user's Exchange mailbox as key value pair

How to check if requirement sets are supported by your add-in's Office host

Dev365 — Thu, 29 Oct 2020 11:06:01 +0000

using Office.context.requirements.isSetSupported, It is possible to programmatically check if requirement sets are supported by your add-in's Office host.
if the Office host doesn't support the requirement set, isSetSupported returns false

The following code shows the usage of isSetSupported method.

if (Office.context.requirements.isSetSupported(RequirementSetName, MinimumVersion)) {
}

Example

if (Office.context.requirements.isSetSupported('WordApi', '1.1'))
{
    // Run code that provides additional functionality using the Word JavaScript API when the add-in runs in Word 2016 or later.
}

Search and highlight text using word add-in

Dev365 — Mon, 26 Oct 2020 05:50:45 +0000

If you want to search the word document for text and need to highlight with a color, following code can be used
This code sample searches for the text "Office" and ignores punctuation. If the text is found, the matches are bolded, highlighted in yellow, and the font color set to purple.

 // Run a batch operation against the Word object model.
Word.run(function (context) {
  // Queue a command to search the document and ignore punctuation.
  var searchResults = context.document.body.search('Office', {ignorePunct: true});

  // Queue a command to load the search results and get the font property values.
  context.load(searchResults, 'font');

  // Synchronize the document state by executing the queued commands,
  // and return a promise to indicate task completion.
  return context.sync().then(function () {
      console.log('Found count: ' + searchResults.items.length);

      // Queue a set of commands to change the font for each found item.
      for (var i = 0; i < searchResults.items.length; i++) {
        searchResults.items[i].font.color = 'purple';
        searchResults.items[i].font.highlightColor = '#FFFF00'; // Yellow
        searchResults.items[i].font.bold = true;
      }

      // Synchronize the document state by executing the queued commands,
      // and return a promise to indicate task completion.
      return context.sync();
  });
})
.catch(function (error) {
  console.log('Error: ' + JSON.stringify(error));
  if (error instanceof OfficeExtension.Error) {
    console.log('Debug info: ' + JSON.stringify(error.debugInfo));
  }
});

Validating an Office add-in's manifest file

Dev365 — Sun, 25 Oct 2020 18:31:03 +0000

The Office add-ins manifest validator examines your add-in's manifest file to determine if it's correct and complete.
If you created your add-in project using the Yeoman generator for Office add-ins (version 1.1.17 or later),
you can validate the manifest by running the following command in the root directory of the project.

Console

npm run validate

If you didn't use the Yeoman generator to create your add-in project, you can validate your add-in's manifest by completing the following steps.

Install Node.js.
Run the following command in the root directory of your project.

Important
Replace MANIFEST_FILE with the name of your manifest file.

Console

npx office-addin-manifest validate {{MANIFEST_FILE}}