-
Notifications
You must be signed in to change notification settings - Fork 6
/
microsoftTeams.people.PeoplePickerInputs.yml
69 lines (69 loc) · 2.28 KB
/
microsoftTeams.people.PeoplePickerInputs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
### YamlMime:TSType
name: PeoplePickerInputs
uid: '@microsoft/teams-js.microsoftTeams.people.PeoplePickerInputs'
package: '@microsoft/teams-js'
summary: 'Input parameter supplied to the People Picker API'
fullName: PeoplePickerInputs
remarks: ''
isDeprecated: false
type: interface
properties:
- name: openOrgWideSearchInChatOrChannel
uid: >-
@microsoft/teams-js.microsoftTeams.people.PeoplePickerInputs.openOrgWideSearchInChatOrChannel
package: '@microsoft/teams-js'
summary: >-
Optional; launches the people picker in org wide scope even if the app
is added to a chat or channel. Default value is false.
fullName: openOrgWideSearchInChatOrChannel
remarks: ''
isDeprecated: false
syntax:
content: 'openOrgWideSearchInChatOrChannel?: boolean'
return:
description: ''
type: boolean
- name: setSelected
uid: '@microsoft/teams-js.microsoftTeams.people.PeoplePickerInputs.setSelected'
package: '@microsoft/teams-js'
summary: >-
Optional; AAD 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.
fullName: setSelected
remarks: ''
isDeprecated: false
syntax:
content: 'setSelected?: string[]'
return:
description: ''
type: string[]
- name: singleSelect
uid: '@microsoft/teams-js.microsoftTeams.people.PeoplePickerInputs.singleSelect'
package: '@microsoft/teams-js'
summary: >-
Optional; launches the people picker for which only 1 person can be
selected. Default value is false.
fullName: singleSelect
remarks: ''
isDeprecated: false
syntax:
content: 'singleSelect?: boolean'
return:
description: ''
type: boolean
- name: title
uid: '@microsoft/teams-js.microsoftTeams.people.PeoplePickerInputs.title'
package: '@microsoft/teams-js'
summary: >-
Optional; Set title for the people picker. Default value is
"Select people" for multiselect and "Select a person" for single select.
fullName: title
remarks: ''
isDeprecated: false
syntax:
content: 'title?: string'
return:
description: ''
type: string