-
Notifications
You must be signed in to change notification settings - Fork 16
/
PayloadAssemblerManager.yml
93 lines (93 loc) · 3.48 KB
/
PayloadAssemblerManager.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
### YamlMime:TSType
name: PayloadAssemblerManager
uid: botframework-streaming.PayloadAssemblerManager
package: botframework-streaming
summary: Orchestrates assembly of payloads.
fullName: PayloadAssemblerManager
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: >-
PayloadAssemblerManager(StreamManager, (id: string, receiveResponse:
IReceiveResponse) => Promise<void>, (id: string, receiveRequest:
IReceiveRequest) => Promise<void>)
uid: botframework-streaming.PayloadAssemblerManager.constructor
package: botframework-streaming
summary: >-
Initializes a new instance of the
[PayloadAssemblerManager](xref:botframework-streaming.PayloadAssemblerManager)
class.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new PayloadAssemblerManager(streamManager: StreamManager,
onReceiveResponse: (id: string, receiveResponse: IReceiveResponse) =>
Promise<void>, onReceiveRequest: (id: string, receiveRequest:
IReceiveRequest) => Promise<void>)
parameters:
- id: streamManager
type: <xref uid="botframework-streaming.StreamManager" />
description: >-
The [StreamManager](xref:botframework-streaming.StreamManager)
managing the stream being assembled.
- id: onReceiveResponse
type: >-
(id: string, receiveResponse: IReceiveResponse) =>
Promise<void>
description: >-
Function that executes when new bytes are received on a `response`
stream.
- id: onReceiveRequest
type: >-
(id: string, receiveRequest: IReceiveRequest) =>
Promise<void>
description: >
Function that executes when new bytes are received on a `request`
stream.
methods:
- name: getPayloadStream(IHeader)
uid: botframework-streaming.PayloadAssemblerManager.getPayloadStream
package: botframework-streaming
summary: Retrieves the assembler's payload as a stream.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function getPayloadStream(header: IHeader): SubscribableStream'
parameters:
- id: header
type: <xref uid="botframework-streaming.IHeader" />
description: The Header of the Stream to retrieve.
return:
description: >-
A [SubscribableStream](xref:botframework-streaming.SubscribableStream)
of the assembler's payload.
type: <xref uid="botframework-streaming.SubscribableStream" />
- name: 'onReceive(IHeader, SubscribableStream, number)'
uid: botframework-streaming.PayloadAssemblerManager.onReceive
package: botframework-streaming
summary: >-
The action the assembler executes when new bytes are received on the
incoming stream.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function onReceive(header: IHeader, contentStream: SubscribableStream,
contentLength: number)
parameters:
- id: header
type: <xref uid="botframework-streaming.IHeader" />
description: The stream's Header.
- id: contentStream
type: <xref uid="botframework-streaming.SubscribableStream" />
description: The incoming stream being assembled.
- id: contentLength
type: number
description: |
The length of the stream, if finite.