-
Notifications
You must be signed in to change notification settings - Fork 16
/
PayloadReceiver.yml
99 lines (99 loc) · 3.34 KB
/
PayloadReceiver.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
### YamlMime:TSType
name: PayloadReceiver
uid: botframework-streaming.PayloadReceiver
package: botframework-streaming
summary: Payload receiver for streaming.
fullName: PayloadReceiver
remarks: ''
isPreview: false
isDeprecated: false
type: class
properties:
- name: disconnected
uid: botframework-streaming.PayloadReceiver.disconnected
package: botframework-streaming
summary: ''
fullName: disconnected
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'disconnected?: TransportDisconnectedEventHandler'
return:
description: ''
type: >-
<xref uid="botframework-streaming.TransportDisconnectedEventHandler"
/>
- name: isConnected
uid: botframework-streaming.PayloadReceiver.isConnected
package: botframework-streaming
summary: Get current connected state
fullName: isConnected
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: boolean isConnected
return:
description: true if connected to a transport sender.
type: boolean
methods:
- name: connect(ITransportReceiver)
uid: botframework-streaming.PayloadReceiver.connect
package: botframework-streaming
summary: Connects to a transport receiver
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function connect(receiver: ITransportReceiver): Promise<void>'
parameters:
- id: receiver
type: <xref uid="botframework-streaming.ITransportReceiver" />
description: >-
The
[ITransportReceiver](xref:botframework-streaming.ITransportReceiver)
object to pull incoming data from.
return:
description: a promise that resolves when the receiver is complete
type: Promise<void>
- name: disconnect(TransportDisconnectedEvent)
uid: botframework-streaming.PayloadReceiver.disconnect
package: botframework-streaming
summary: Force this receiver to disconnect.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function disconnect(event?: TransportDisconnectedEvent)'
parameters:
- id: event
type: <xref uid="botframework-streaming.TransportDisconnectedEvent" />
description: |
Event arguments to include when broadcasting disconnection event.
- name: >-
subscribe((header: IHeader) => SubscribableStream, (header: IHeader,
stream: SubscribableStream, count: number) => void)
uid: botframework-streaming.PayloadReceiver.subscribe
package: botframework-streaming
summary: >-
Allows subscribing to this receiver in order to be notified when new data
comes in.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function subscribe(getStream: (header: IHeader) => SubscribableStream,
receiveAction: (header: IHeader, stream: SubscribableStream, count:
number) => void)
parameters:
- id: getStream
type: '(header: IHeader) => SubscribableStream'
description: Callback when a new stream has been received.
- id: receiveAction
type: >-
(header: IHeader, stream: SubscribableStream, count: number) =>
void
description: |
Callback when a new message has been received.