-
Notifications
You must be signed in to change notification settings - Fork 10
/
IExtensionDataManager.yml
240 lines (239 loc) · 9.06 KB
/
IExtensionDataManager.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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
### YamlMime:TSType
name: IExtensionDataManager
uid: azure-devops-extension-api.IExtensionDataManager
package: azure-devops-extension-api
summary: ''
fullName: IExtensionDataManager
remarks: ''
isDeprecated: false
type: interface
methods:
- name: createDocument(string, any, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.createDocument
package: azure-devops-extension-api
summary: Returns a promise for creating a document in the provided collection
remarks: ''
isDeprecated: false
syntax:
content: >-
function createDocument(collectionName: string, doc: any,
documentOptions?: IDocumentOptions): Promise<any>
parameters:
- id: collectionName
type: string
description: The name of the collection where the document lives
- id: doc
type: any
description: The document to store
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<any>
- name: deleteDocument(string, string, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.deleteDocument
package: azure-devops-extension-api
summary: >-
Returns a promise for deleting the document at the provided scope,
collection and id
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteDocument(collectionName: string, id: string,
documentOptions?: IDocumentOptions): Promise<void>
parameters:
- id: collectionName
type: string
description: The name of the collection where the document lives
- id: id
type: string
description: The id of the document in the collection
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<void>
- name: getDocument(string, string, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.getDocument
package: azure-devops-extension-api
summary: >-
Returns a promise for getting a document with the provided id in the
provided collection
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDocument(collectionName: string, id: string,
documentOptions?: IDocumentOptions): Promise<any>
parameters:
- id: collectionName
type: string
description: The name of the collection where the document lives
- id: id
type: string
description: The id of the document in the collection
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<any>
- name: getDocuments(string, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.getDocuments
package: azure-devops-extension-api
summary: >-
Returns a promise for getting all of the documents in the provided
collection
remarks: ''
isDeprecated: false
syntax:
content: >-
function getDocuments(collectionName: string, documentOptions?:
IDocumentOptions): Promise<any[]>
parameters:
- id: collectionName
type: string
description: The name of the collection where the document lives
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<any[]>
- name: getValue<T>(string, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.getValue
package: azure-devops-extension-api
summary: Returns a promise for retrieving a setting at the provided key and scope
remarks: ''
isDeprecated: false
syntax:
content: >-
function getValue<T>(key: string, documentOptions?: IDocumentOptions):
Promise<T>
parameters:
- id: key
type: string
description: The key to retrieve a value for
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<T>
- name: queryCollections(ExtensionDataCollection[])
uid: azure-devops-extension-api.IExtensionDataManager.queryCollections
package: azure-devops-extension-api
summary: Returns a promise for querying a set of collections
remarks: ''
isDeprecated: false
syntax:
content: >-
function queryCollections(collections: ExtensionDataCollection[]):
Promise<ExtensionDataCollection[]>
parameters:
- id: collections
type: <xref uid="azure-devops-extension-api.ExtensionDataCollection" />[]
description: >-
The list of collections to query. Each collection will contain its
collectionName, scopeType, and scopeValue
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.ExtensionDataCollection" />[]>
- name: queryCollectionsByName(string[])
uid: azure-devops-extension-api.IExtensionDataManager.queryCollectionsByName
package: azure-devops-extension-api
summary: Returns a promise for querying a set of collections
remarks: ''
isDeprecated: false
syntax:
content: >-
function queryCollectionsByName(collectionNames: string[]):
Promise<ExtensionDataCollection[]>
parameters:
- id: collectionNames
type: string[]
description: ''
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.ExtensionDataCollection" />[]>
- name: setDocument(string, any, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.setDocument
package: azure-devops-extension-api
summary: >-
Returns a promise for setting a document in the provided collection
Creates the document if it does not exist, otherwise updates the existing
document with the id provided
remarks: ''
isDeprecated: false
syntax:
content: >-
function setDocument(collectionName: string, doc: any, documentOptions?:
IDocumentOptions): Promise<any>
parameters:
- id: collectionName
type: string
description: The name of the collection where the document lives
- id: doc
type: any
description: The document to store
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<any>
- name: setValue<T>(string, T, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.setValue
package: azure-devops-extension-api
summary: Returns a promise for saving a setting at the provided key and scope
remarks: ''
isDeprecated: false
syntax:
content: >-
function setValue<T>(key: string, value: T, documentOptions?:
IDocumentOptions): Promise<T>
parameters:
- id: key
type: string
description: The key to save a value for
- id: value
type: T
description: The value to save
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<T>
- name: updateDocument(string, any, IDocumentOptions)
uid: azure-devops-extension-api.IExtensionDataManager.updateDocument
package: azure-devops-extension-api
summary: |-
Returns a promise for updating a document in the provided collection
A document with the id provided must exist
remarks: ''
isDeprecated: false
syntax:
content: >-
function updateDocument(collectionName: string, doc: any,
documentOptions?: IDocumentOptions): Promise<any>
parameters:
- id: collectionName
type: string
description: The name of the collection where the document lives
- id: doc
type: any
description: The document to store
- id: documentOptions
type: <xref uid="azure-devops-extension-api.IDocumentOptions" />
description: Extension document options, the default scope value is account-wide
return:
description: ''
type: Promise<any>