IExtensionDataManager interface

Пакет:

azure-devops-extension-api

Методы

createDocument(string, any, IDocumentOptions)	Возвращает промис для создания документа в предоставленной коллекции
deleteDocument(string, string, IDocumentOptions)	Возвращает обещание удаления документа в предоставленной области, коллекции и id
getDocument(string, string, IDocumentOptions)	Возвращает обещание получить документ с указанным идентификатором в предоставленной коллекции
getDocuments(string, IDocumentOptions)	Возвращает обещание получить все документы в предоставленной коллекции
getValue<T>(string, IDocumentOptions)	Возвращает обещание для получения параметра по предоставленному ключу и области
queryCollections(ExtensionDataCollection[])	Возвращает промис для запроса набора коллекций
queryCollectionsByName(string[])	Возвращает промис для запроса набора коллекций
setDocument(string, any, IDocumentOptions)	Возвращает обещание для установки документа в предоставленной коллекции Создает документ, если он не существует, в противном случае обновляет существующий документ с указанным идентификатором
setValue<T>(string, T, IDocumentOptions)	Возвращает обещание сохранения параметра в предоставленном ключе и области
updateDocument(string, any, IDocumentOptions)	Возвращает обещание обновления документа в предоставленной коллекции Документ с предоставленным идентификатором должен существовать

Сведения о методе

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

Идентификатор документа в коллекции

documentOptions

IDocumentOptions

Параметры документа расширения, значение области по умолчанию — для всей учетной записи

Возвращаемое значение

Promise<void>

getDocument(string, string, IDocumentOptions)

Возвращает обещание получить документ с указанным идентификатором в предоставленной коллекции

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

Параметры

collectionName

string

Название коллекции, в которой находится документ

id

string

Идентификатор документа в коллекции

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[])

Возвращает промис для запроса набора коллекций

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

Параметры

collections

ExtensionDataCollection[]

Список коллекций для запроса. Каждая коллекция будет содержать свои collectionName, scopeType и scopeValue

Возвращаемое значение

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Возвращает промис для запроса набора коллекций

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

Параметры

collectionNames

string[]

Возвращаемое значение

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Возвращает обещание для установки документа в предоставленной коллекции Создает документ, если он не существует, в противном случае обновляет существующий документ с указанным идентификатором

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

Параметры

collectionName

string

Название коллекции, в которой находится документ

doc

any

Документ для хранения

documentOptions

IDocumentOptions

Параметры документа расширения, значение области по умолчанию — для всей учетной записи

Возвращаемое значение

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Возвращает обещание сохранения параметра в предоставленном ключе и области

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

Параметры

key

string

Ключ, для которого нужно сохранить значение

value

T

Ценность для экономии

documentOptions

IDocumentOptions

Параметры документа расширения, значение области по умолчанию — для всей учетной записи

Возвращаемое значение

Promise<T>

updateDocument(string, any, IDocumentOptions)

Возвращает обещание обновления документа в предоставленной коллекции Документ с предоставленным идентификатором должен существовать

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

Параметры

collectionName

string

Название коллекции, в которой находится документ

doc

any

Документ для хранения

documentOptions

IDocumentOptions

Параметры документа расширения, значение области по умолчанию — для всей учетной записи

Возвращаемое значение

Promise<any>