-
Notifications
You must be signed in to change notification settings - Fork 6
/
chat.yml
58 lines (56 loc) · 1.99 KB
/
chat.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
### YamlMime:TSPackage
uid: '@microsoft/teams-js.chat'
name: chat
type: module
package: '@microsoft/teams-js'
summary: Contains functionality to start chat with others
functions:
- name: isSupported()
uid: '@microsoft/teams-js.chat.isSupported'
package: '@microsoft/teams-js'
summary: Checks if the chat capability is supported by the host
remarks: ''
isDeprecated: false
syntax:
content: 'function isSupported(): boolean'
return:
description: boolean to represent whether the chat capability is supported
type: boolean
- name: openChat(OpenSingleChatRequest)
uid: '@microsoft/teams-js.chat.openChat'
package: '@microsoft/teams-js'
summary: |-
Allows the user to open a chat with a single user and allows
for the user to specify the message they wish to send.
remarks: ''
isDeprecated: false
syntax:
content: 'function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>'
parameters:
- id: openChatRequest
type: <xref uid="@microsoft/teams-js.OpenSingleChatRequest" />
description: ''
return:
description: Promise resolved upon completion
type: Promise<void>
- name: openGroupChat(OpenGroupChatRequest)
uid: '@microsoft/teams-js.chat.openGroupChat'
package: '@microsoft/teams-js'
summary: >-
Allows the user to create a chat with multiple users (2+) and allows
for the user to specify a message and name the topic of the conversation.
If
only 1 user is provided into users array default back to origin openChat.
remarks: ''
isDeprecated: false
syntax:
content: >-
function openGroupChat(openChatRequest: OpenGroupChatRequest):
Promise<void>
parameters:
- id: openChatRequest
type: <xref uid="@microsoft/teams-js.OpenGroupChatRequest" />
description: ''
return:
description: Promise resolved upon completion
type: Promise<void>