PeoplePickerInputs interface

Package:

@microsoft/teams-js

Input parameter supplied to the People Picker API

Properties

openOrgWideSearchInChatOrChannel	Optional; launches the people picker in org wide scope even if the app is added to a chat or channel Default value is false
setSelected	Optional; Microsoft Entra IDs of the users to be pre-populated in the search box of people picker control If single select is enabled this value, only the first user in the list will be pre-populated Default value is null
singleSelect	Optional; launches the people picker for which only 1 person can be selected Default value is false
title	Optional; Set title for the people picker Default value is "Select people" for multiselect and "Select a person" for single select

Property Details

openOrgWideSearchInChatOrChannel

Optional; launches the people picker in org wide scope even if the app is added to a chat or channel Default value is false

openOrgWideSearchInChatOrChannel?: boolean

Property Value

boolean

setSelected

Optional; Microsoft Entra IDs of the users to be pre-populated in the search box of people picker control If single select is enabled this value, only the first user in the list will be pre-populated Default value is null

setSelected?: string[]

Property Value

string[]

singleSelect

Optional; launches the people picker for which only 1 person can be selected Default value is false

singleSelect?: boolean

Property Value

boolean

title

Optional; Set title for the people picker Default value is "Select people" for multiselect and "Select a person" for single select

title?: string

Property Value

string