Partager via

profile module

  • Reference
Package:
@microsoft/teams-js

Note

This namespace is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Namespace for profile related APIs.

Interfaces

Persona

The persona to show the profile for.
ShowProfileRequest

Input parameters provided to the showProfile API.

Type Aliases

Modality

The type of modalities that are supported when showing a profile. Can be provided as an optional hint with the request and will be respected if the hosting M365 application supports it.
PersonaIdentifiers

The set of identifiers that are supported for resolving the persona.

At least one is required, and if multiple are provided then only the highest priority one will be used (AadObjectId > Upn > Smtp). AAD is now known as "Microsoft Entra ID"
TriggerType

The type of the profile trigger.

  • MouseHover: The user hovered a target.
  • Press: The target was pressed with either a mouse click or keyboard key press.
  • AppRequest: The show profile request is happening programmatically, without direct user interaction.

Functions

isSupported()

Checks if the profile capability is supported by the host
showProfile(ShowProfileRequest)

Opens a profile card at a specified position to show profile information about a persona.

Function Details

isSupported()

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Checks if the profile capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether the profile capability is supported

showProfile(ShowProfileRequest)

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Opens a profile card at a specified position to show profile information about a persona.

function showProfile(showProfileRequest: ShowProfileRequest): Promise<void>

Parameters

showProfileRequest
ShowProfileRequest

The parameters to position the card and identify the target user.

Returns

Promise<void>

Promise that will be fulfilled when the operation has completed