-
Notifications
You must be signed in to change notification settings - Fork 7
/
call.StartCallParams.yml
56 lines (54 loc) · 1.67 KB
/
call.StartCallParams.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
### YamlMime:TSType
name: StartCallParams
uid: '@microsoft/teams-js.call.StartCallParams'
package: '@microsoft/teams-js'
summary: >-
Represents parameters for
[StartCall](xref:@microsoft/teams-js.call.startCall).
fullName: StartCallParams
remarks: ''
isDeprecated: false
type: interface
properties:
- name: requestedModalities
uid: '@microsoft/teams-js.call.StartCallParams.requestedModalities'
package: '@microsoft/teams-js'
summary: List of modalities for the call. Defaults to [“audio”].
fullName: requestedModalities
remarks: ''
isDeprecated: false
syntax:
content: 'requestedModalities?: CallModalities[]'
return:
description: ''
type: <xref uid="@microsoft/teams-js.call.CallModalities" />[]
- name: source
uid: '@microsoft/teams-js.call.StartCallParams.source'
package: '@microsoft/teams-js'
summary: An optional parameter that informs about the source of the deep link
fullName: source
remarks: ''
isDeprecated: false
syntax:
content: 'source?: string'
return:
description: ''
type: string
- name: targets
uid: '@microsoft/teams-js.call.StartCallParams.targets'
package: '@microsoft/teams-js'
summary: >-
Comma-separated list of user IDs representing the participants of the
call.
fullName: targets
remarks: >-
Currently the User ID field supports the Microsoft Entra
UserPrincipalName,
typically an email address, or in case of a PSTN call, it supports a pstn
mri 4:\<phonenumber>.
isDeprecated: false
syntax:
content: 'targets: string[]'
return:
description: ''
type: string[]