-
Notifications
You must be signed in to change notification settings - Fork 16
/
WebSocketClient.yml
76 lines (76 loc) · 2.64 KB
/
WebSocketClient.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
70
71
72
73
74
75
76
### YamlMime:TSType
name: WebSocketClient
uid: botframework-streaming.WebSocketClient
package: botframework-streaming
summary: Web socket based client to be used as streaming transport.
fullName: WebSocketClient
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: >-
WebSocketClient({ disconnectionHandler: (message: string) => void,
requestHandler: RequestHandler, url: string })
uid: botframework-streaming.WebSocketClient.constructor
package: botframework-streaming
summary: >-
Creates a new instance of the
[WebSocketClient](xref:botframework-streaming.WebSocketClient) class.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new WebSocketClient(__namedParameters: { disconnectionHandler: (message:
string) => void, requestHandler: RequestHandler, url: string })
parameters:
- id: __namedParameters
type: >-
{ disconnectionHandler: (message: string) => void,
requestHandler: RequestHandler, url: string }
description: ''
methods:
- name: connect()
uid: botframework-streaming.WebSocketClient.connect
package: botframework-streaming
summary: Establish a connection with no custom headers.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function connect(): Promise<void>'
return:
description: >-
A promise that will not resolve until the client stops listening for
incoming messages.
type: Promise<void>
- name: disconnect()
uid: botframework-streaming.WebSocketClient.disconnect
package: botframework-streaming
summary: Stop this client from listening.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: function disconnect()
- name: send(StreamingRequest)
uid: botframework-streaming.WebSocketClient.send
package: botframework-streaming
summary: Task used to send data over this client connection.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function send(request: StreamingRequest): Promise<IReceiveResponse>'
parameters:
- id: request
type: <xref uid="botframework-streaming.StreamingRequest" />
description: >-
The [StreamingRequest](xref:botframework-streaming.StreamingRequest)
instance to send.
return:
description: >-
A promise that will produce an instance of receive response on
completion of the send operation.
type: Promise<<xref uid="botframework-streaming.IReceiveResponse" />>