通过

IExtensionDataManager interface

包:
azure-devops-extension-api

方法

createDocument(string, any, IDocumentOptions)

返回在提供的集合中创建文档的承诺
deleteDocument(string, string, IDocumentOptions)

返回一个承诺，用于删除所提供范围、集合和 id 的文档
getDocument(string, string, IDocumentOptions)

返回一个承诺，用于在提供的集合中获取具有提供 ID 的文档
getDocuments(string, IDocumentOptions)

返回获取所提供集合中所有文档的承诺
getValue<T>(string, IDocumentOptions)

返回一个承诺，用于在提供的键和作用域中检索设置
queryCollections(ExtensionDataCollection[])

返回查询一组集合的 Promise
queryCollectionsByName(string[])

返回查询一组集合的 Promise
setDocument(string, any, IDocumentOptions)

返回在提供的集合中设置文档的 promise如果文档不存在，则创建文档，否则使用提供的 id 更新现有文档
setValue<T>(string, T, IDocumentOptions)

返回在提供的键和作用域保存设置的 Promise
updateDocument(string, any, IDocumentOptions)

返回更新所提供集合中文档的承诺必须存在具有提供 ID 的文档

方法详细信息

createDocument(string, any, IDocumentOptions)

返回在提供的集合中创建文档的承诺

function createDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>

参数

collectionName

string

文档所在的集合的名称

doc

any

要存储的文档

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<any>

deleteDocument(string, string, IDocumentOptions)

返回一个承诺，用于删除所提供范围、集合和 id 的文档

function deleteDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<void>

参数

collectionName

string

文档所在的集合的名称

id

string

集合中文档的 ID

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<void>

getDocument(string, string, IDocumentOptions)

返回一个承诺，用于在提供的集合中获取具有提供 ID 的文档

function getDocument(collectionName: string, id: string, documentOptions?: IDocumentOptions): Promise<any>

参数

collectionName

string

文档所在的集合的名称

id

string

集合中文档的 ID

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<any>

getDocuments(string, IDocumentOptions)

返回获取所提供集合中所有文档的承诺

function getDocuments(collectionName: string, documentOptions?: IDocumentOptions): Promise<any[]>

参数

collectionName

string

文档所在的集合的名称

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<any[]>

getValue<T>(string, IDocumentOptions)

返回一个承诺，用于在提供的键和作用域中检索设置

function getValue<T>(key: string, documentOptions?: IDocumentOptions): Promise<T>

参数

key

string

用于检索值的键

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<T>

queryCollections(ExtensionDataCollection[])

返回查询一组集合的 Promise

function queryCollections(collections: ExtensionDataCollection[]): Promise<ExtensionDataCollection[]>

参数

collections

ExtensionDataCollection[]

要查询的集合列表。 每个集合将包含其 collectionName、scopeType 和 scopeValue

返回

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

返回查询一组集合的 Promise

function queryCollectionsByName(collectionNames: string[]): Promise<ExtensionDataCollection[]>

参数

collectionNames

string[]

返回

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

返回在提供的集合中设置文档的 promise如果文档不存在，则创建文档，否则使用提供的 id 更新现有文档

function setDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>

参数

collectionName

string

文档所在的集合的名称

doc

any

要存储的文档

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<any>

setValue<T>(string, T, IDocumentOptions)

返回在提供的键和作用域保存设置的 Promise

function setValue<T>(key: string, value: T, documentOptions?: IDocumentOptions): Promise<T>

参数

key

string

保存值的键

value

T

要保存的价值

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<T>

updateDocument(string, any, IDocumentOptions)

返回更新所提供集合中文档的承诺必须存在具有提供 ID 的文档

function updateDocument(collectionName: string, doc: any, documentOptions?: IDocumentOptions): Promise<any>

参数

collectionName

string

文档所在的集合的名称

doc

any

要存储的文档

documentOptions
IDocumentOptions

扩展文档选项，默认范围值为帐户范围

返回

Promise<any>