-
Notifications
You must be signed in to change notification settings - Fork 16
/
ConnectedService.yml
120 lines (120 loc) · 3.85 KB
/
ConnectedService.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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
### YamlMime:TSType
name: ConnectedService
uid: botframework-config.ConnectedService
package: botframework-config
summary: Base class for all connected service definitions.
fullName: ConnectedService
remarks: ''
isPreview: false
isDeprecated: true
customDeprecatedMessage: 'See https://aka.ms/bot-file-basics for more information.'
type: class
constructors:
- name: 'ConnectedService(IConnectedService, ServiceTypes)'
uid: botframework-config.ConnectedService.constructor
package: botframework-config
summary: Creates a new ConnectedService instance.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'new ConnectedService(source?: IConnectedService, type?: ServiceTypes)'
parameters:
- id: source
type: <xref uid="botframework-config.IConnectedService" />
description: (Optional) JSON based service definition.
- id: type
type: <xref uid="botframework-config.ServiceTypes" />
description: |
(Optional) type of service being defined.
properties:
- name: id
uid: botframework-config.ConnectedService.id
package: botframework-config
summary: Unique Id for the service.
fullName: id
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'id: string'
return:
description: ''
type: string
- name: name
uid: botframework-config.ConnectedService.name
package: botframework-config
summary: Friendly name for the service.
fullName: name
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
- name: type
uid: botframework-config.ConnectedService.type
package: botframework-config
summary: ''
fullName: type
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'type?: ServiceTypes'
return:
description: ''
type: <xref uid="botframework-config.ServiceTypes" />
methods:
- name: 'decrypt(string, (value: string, secret: string) => string)'
uid: botframework-config.ConnectedService.decrypt
package: botframework-config
summary: Decrypt properties on this service.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function decrypt(_secret: string, _decryptString: (value: string,
secret: string) => string)
parameters:
- id: _secret
type: string
description: Secret to use to decrypt the keys in this service.
- id: _decryptString
type: '(value: string, secret: string) => string'
description: |
Function called to decrypt an individual value.
- name: 'encrypt(string, (value: string, secret: string) => string)'
uid: botframework-config.ConnectedService.encrypt
package: botframework-config
summary: Encrypt properties on this service.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
function encrypt(_secret: string, _encryptString: (value: string,
secret: string) => string)
parameters:
- id: _secret
type: string
description: Secret to use to encrypt the keys in this service.
- id: _encryptString
type: '(value: string, secret: string) => string'
description: |
Function called to encrypt an individual value.
- name: toJSON()
uid: botframework-config.ConnectedService.toJSON
package: botframework-config
summary: Creates a JSON based version of the model for saving to disk.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'function toJSON(): IConnectedService'
return:
description: An IConnectedService JSON.
type: <xref uid="botframework-config.IConnectedService" />