Share via

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

Functions

selectPeople((error: SdkError, people: PeoplePickerResult[]) => void, 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 Details

selectPeople((error: SdkError, people: PeoplePickerResult[]) => void, 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(callback: (error: SdkError, people: PeoplePickerResult[]) => void, peoplePickerInputs?: PeoplePickerInputs)

Parameters

callback

(error: SdkError, people: PeoplePickerResult[]) => void

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

peoplePickerInputs

@microsoft/teams-js.@microsoft.teams-js.people.PeoplePickerInputs

Input parameters to launch customized people picker