people module

  • Reference
Package:
@microsoft/teams-js

Interfaces

PeoplePickerInputs

Input parameter supplied to the People Picker API
PeoplePickerResult

Output user object of people picker API

Type Aliases

selectPeopleCallbackFunctionType

Select people callback function type

Functions

isSupported()

Checks if the people capability is supported by the host
selectPeople(PeoplePickerInputs)

Launches a people picker and allows the user to select one or more people from the list If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
selectPeople(selectPeopleCallbackFunctionType, PeoplePickerInputs)

Function Details

isSupported()

Checks if the people capability is supported by the host

function isSupported(): boolean

Returns

boolean

boolean to represent whether the people capability is supported

selectPeople(PeoplePickerInputs)

Launches a people picker and allows the user to select one or more people from the list If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel

function selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]>

Parameters

peoplePickerInputs
PeoplePickerInputs

Input parameters to launch customized people picker

Returns

Promise<PeoplePickerResult[]>

Promise that will be fulfilled when the operation has completed

selectPeople(selectPeopleCallbackFunctionType, PeoplePickerInputs)

Warning

This API is now deprecated.

As of 2.0.0, please use people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]> instead.

Launches a people picker and allows the user to select one or more people from the list If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel

function selectPeople(callback: selectPeopleCallbackFunctionType, peoplePickerInputs?: PeoplePickerInputs)

Parameters

callback
selectPeopleCallbackFunctionType

Returns list of JSON object of type PeoplePickerResult which consists of Microsoft Entra IDs, display names and emails of the selected users

peoplePickerInputs
PeoplePickerInputs

Input parameters to launch customized people picker