-
Notifications
You must be signed in to change notification settings - Fork 16
/
RegisterClassMiddleware.yml
67 lines (67 loc) · 2.07 KB
/
RegisterClassMiddleware.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
### YamlMime:TSType
name: RegisterClassMiddleware
uid: botbuilder-core.RegisterClassMiddleware
package: botbuilder-core
summary: >-
Middleware for adding an object to or registering a service with the current
turn context.
fullName: RegisterClassMiddleware<T>
remarks: ''
isPreview: false
isDeprecated: false
type: class
constructors:
- name: 'RegisterClassMiddleware(T, string | symbol)'
uid: botbuilder-core.RegisterClassMiddleware.constructor
package: botbuilder-core
summary: Initialize a new instance of the RegisterClassMiddleware class.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'new RegisterClassMiddleware(service: T, key: string | symbol)'
parameters:
- id: service
type: T
description: The object or service to add.
- id: key
type: string | symbol
description: |
The key for service object in turn state.
properties:
- name: service
uid: botbuilder-core.RegisterClassMiddleware.service
package: botbuilder-core
summary: The object or service to add to the turn context.
fullName: service
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'service: T'
return:
description: ''
type: T
methods:
- name: 'onTurn(TurnContext, () => Promise<void>)'
uid: botbuilder-core.RegisterClassMiddleware.onTurn
package: botbuilder-core
summary: Adds the associated object or service to the current turn context.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function onTurn(turnContext: TurnContext, next: () => Promise<void>):
Promise<void>
parameters:
- id: turnContext
type: <xref uid="botbuilder-core.TurnContext" />
description: The context object for this turn.
- id: next
type: () => Promise<void>
description: |
The delegate to call to continue the bot middleware pipeline.
return:
description: ''
type: Promise<void>