/
ResponseDisassembler.yml
100 lines (100 loc) · 3.41 KB
/
ResponseDisassembler.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
100
### YamlMime:TSType
name: ResponseDisassembler
uid: botframework-streaming.ResponseDisassembler
package: botframework-streaming
summary: Streaming response disassembler.
fullName: ResponseDisassembler
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: 'ResponseDisassembler(PayloadSender, string, StreamingResponse)'
uid: botframework-streaming.ResponseDisassembler.constructor
package: botframework-streaming
summary: >-
Initializes a new instance of the
[ResponseDisassembler](xref:botframework-streaming.ResponseDisassembler)
class.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
new ResponseDisassembler(sender: PayloadSender, id: string, response:
StreamingResponse)
parameters:
- id: sender
type: <xref uid="botframework-streaming.PayloadSender" />
description: >-
The [PayloadSender](xref:botframework-streaming.PayloadSender) to
send the disassembled data to.
- id: id
type: string
description: The ID of this disassembler.
- id: response
type: <xref uid="botframework-streaming.StreamingResponse" />
description: |
The response to be disassembled.
properties:
- name: payloadType
uid: botframework-streaming.ResponseDisassembler.payloadType
package: botframework-streaming
summary: ''
fullName: payloadType
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'payloadType: PayloadTypes'
return:
description: ''
type: <xref uid="botframework-streaming.PayloadTypes" />
- name: response
uid: botframework-streaming.ResponseDisassembler.response
package: botframework-streaming
summary: ''
fullName: response
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'response: StreamingResponse'
return:
description: ''
type: <xref uid="botframework-streaming.StreamingResponse" />
inheritedMethods:
- name: disassemble()
uid: botframework-streaming.ResponseDisassembler.disassemble
package: botframework-streaming
summary: >-
Begins the process of disassembling a payload and sending the resulting
chunks to the [PayloadSender](xref:botframework-streaming.PayloadSender)
to dispatch over the transport.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function disassemble(): Promise<void>'
return:
description: A completed Promise after the disassembled payload has been sent.
type: Promise<void>
inheritanceDescription: >-
<b>Inherited From</b>
[PayloadDisassembler.disassemble](xref:botframework-streaming.PayloadDisassembler.disassemble)
methods:
- name: getStream()
uid: botframework-streaming.ResponseDisassembler.getStream
package: botframework-streaming
summary: Gets the stream this disassembler is operating on.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function getStream(): Promise<IStreamWrapper>'
return:
description: >-
An [IStreamWrapper](xref:botframework-streaming.IStreamWrapper) with a
Subscribable Stream.
type: Promise<<xref uid="botframework-streaming.IStreamWrapper" />>
extends: <xref uid="botframework-streaming.PayloadDisassembler" />