IExtensionDataManager interface

Pakiet:

azure-devops-extension-api

Metody

createDocument(string, any, IDocumentOptions)	Zwraca przyrzeczenie utworzenia dokumentu w podanej kolekcji
deleteDocument(string, string, IDocumentOptions)	Zwraca obietnicę usunięcia dokumentu w podanym zakresie, kolekcji i identyfikatorze
getDocument(string, string, IDocumentOptions)	Zwraca obietnicę uzyskania dokumentu o podanym identyfikatorze w podanej kolekcji
getDocuments(string, IDocumentOptions)	Zwraca obietnicę pobrania wszystkich dokumentów w podanej kolekcji
getValue<T>(string, IDocumentOptions)	Zwraca obietnicę pobrania ustawienia w podanym kluczu i zakresie.
queryCollections(ExtensionDataCollection[])	Zwraca obietnicę dotyczącą wykonywania zapytania dotyczącego zestawu kolekcji
queryCollectionsByName(string[])	Zwraca obietnicę dotyczącą wykonywania zapytania dotyczącego zestawu kolekcji
setDocument(string, any, IDocumentOptions)	Zwraca obietnicę ustawienia dokumentu w podanej kolekcji Tworzy dokument, jeśli nie istnieje, w przeciwnym razie aktualizuje istniejący dokument przy użyciu podanego identyfikatora.
setValue<T>(string, T, IDocumentOptions)	Zwraca obietnicę zapisania ustawienia w podanym kluczu i zakresie.
updateDocument(string, any, IDocumentOptions)	Zwraca obietnicę zaktualizowania dokumentu w podanej kolekcji Dokument o podanym identyfikatorze musi istnieć

Szczegóły metody

createDocument(string, any, IDocumentOptions)

Zwraca przyrzeczenie utworzenia dokumentu w podanej kolekcji

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

Parametry

collectionName

string

Nazwa kolekcji, w której znajduje się dokument

doc

any

Dokument do przechowywania

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Zwraca obietnicę usunięcia dokumentu w podanym zakresie, kolekcji i identyfikatorze

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

Parametry

collectionName

string

Nazwa kolekcji, w której znajduje się dokument

id

string

Identyfikator dokumentu w kolekcji

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<void>

getDocument(string, string, IDocumentOptions)

Zwraca obietnicę uzyskania dokumentu o podanym identyfikatorze w podanej kolekcji

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

Parametry

collectionName

string

Nazwa kolekcji, w której znajduje się dokument

id

string

Identyfikator dokumentu w kolekcji

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<any>

getDocuments(string, IDocumentOptions)

Zwraca obietnicę pobrania wszystkich dokumentów w podanej kolekcji

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

Parametry

collectionName

string

Nazwa kolekcji, w której znajduje się dokument

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Zwraca obietnicę pobrania ustawienia w podanym kluczu i zakresie.

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

Parametry

key

string

Klucz do pobrania wartości dla

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<T>

queryCollections(ExtensionDataCollection[])

Zwraca obietnicę dotyczącą wykonywania zapytania dotyczącego zestawu kolekcji

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

Parametry

collections

ExtensionDataCollection[]

Lista kolekcji do wykonania zapytania. Każda kolekcja będzie zawierać swoje collectionName, scopeType i scopeValue

Zwraca

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Zwraca obietnicę dotyczącą wykonywania zapytania dotyczącego zestawu kolekcji

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

Parametry

collectionNames

string[]

Zwraca

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Zwraca obietnicę ustawienia dokumentu w podanej kolekcji Tworzy dokument, jeśli nie istnieje, w przeciwnym razie aktualizuje istniejący dokument przy użyciu podanego identyfikatora.

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

Parametry

collectionName

string

Nazwa kolekcji, w której znajduje się dokument

doc

any

Dokument do przechowywania

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Zwraca obietnicę zapisania ustawienia w podanym kluczu i zakresie.

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

Parametry

key

string

Klucz do zapisania wartości dla

value

T

Wartość do zaoszczędzenia

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<T>

updateDocument(string, any, IDocumentOptions)

Zwraca obietnicę zaktualizowania dokumentu w podanej kolekcji Dokument o podanym identyfikatorze musi istnieć

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

Parametry

collectionName

string

Nazwa kolekcji, w której znajduje się dokument

doc

any

Dokument do przechowywania

documentOptions

IDocumentOptions

Opcje dokumentu rozszerzenia, domyślna wartość zakresu to dla całego konta

Zwraca

Promise<any>