IExtensionDataManager interface

Csomag:

azure-devops-extension-api

Metódusok

createDocument(string, any, IDocumentOptions)	Ígéretet ad vissza egy dokumentum létrehozására a megadott gyűjteményben
deleteDocument(string, string, IDocumentOptions)	Ígéretet ad vissza a dokumentum törlésére a megadott hatókörben, gyűjteményben és azonosítóban
getDocument(string, string, IDocumentOptions)	Ígéretet ad vissza egy dokumentum lekérésére a megadott gyűjteményben megadott azonosítóval
getDocuments(string, IDocumentOptions)	Ígéretet ad vissza az összes dokumentum lekérésére a megadott gyűjteményben
getValue<T>(string, IDocumentOptions)	Ígéretet ad vissza egy beállítás lekéréséhez a megadott kulcson és hatókörön
queryCollections(ExtensionDataCollection[])	Egy gyűjteménykészlet lekérdezésére vonatkozó ígéretet ad vissza
queryCollectionsByName(string[])	Egy gyűjteménykészlet lekérdezésére vonatkozó ígéretet ad vissza
setDocument(string, any, IDocumentOptions)	Ígéretet ad vissza egy dokumentum beállítására a megadott gyűjteményben: Létrehozza a dokumentumot, ha nem létezik, ellenkező esetben frissíti a meglévő dokumentumot a megadott azonosítóval
setValue<T>(string, T, IDocumentOptions)	Ígéretet ad vissza egy beállítás mentésére a megadott kulcson és hatókörön
updateDocument(string, any, IDocumentOptions)	Ígéretet ad vissza egy dokumentum frissítésére a megadott gyűjteményben. A megadott azonosítóval rendelkező dokumentumnak léteznie kell

Metódus adatai

createDocument(string, any, IDocumentOptions)

Ígéretet ad vissza egy dokumentum létrehozására a megadott gyűjteményben

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

Paraméterek

collectionName

string

Annak a gyűjteménynek a neve, amelyben a dokumentum található

doc

any

A tárolni kívánt dokumentum

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Ígéretet ad vissza a dokumentum törlésére a megadott hatókörben, gyűjteményben és azonosítóban

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

Paraméterek

collectionName

string

Annak a gyűjteménynek a neve, amelyben a dokumentum található

id

string

A gyűjteményben lévő dokumentum azonosítója

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<void>

getDocument(string, string, IDocumentOptions)

Ígéretet ad vissza egy dokumentum lekérésére a megadott gyűjteményben megadott azonosítóval

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

Paraméterek

collectionName

string

Annak a gyűjteménynek a neve, amelyben a dokumentum található

id

string

A gyűjteményben lévő dokumentum azonosítója

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<any>

getDocuments(string, IDocumentOptions)

Ígéretet ad vissza az összes dokumentum lekérésére a megadott gyűjteményben

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

Paraméterek

collectionName

string

Annak a gyűjteménynek a neve, amelyben a dokumentum található

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Ígéretet ad vissza egy beállítás lekéréséhez a megadott kulcson és hatókörön

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

Paraméterek

key

string

Az érték lekéréséhez használt kulcs:

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<T>

queryCollections(ExtensionDataCollection[])

Egy gyűjteménykészlet lekérdezésére vonatkozó ígéretet ad vissza

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

Paraméterek

collections

ExtensionDataCollection[]

A lekérdezendő gyűjtemények listája. Minden gyűjtemény tartalmazza a collectionName, scopeType és scopeValue gyűjteményét

Válaszok

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Egy gyűjteménykészlet lekérdezésére vonatkozó ígéretet ad vissza

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

Paraméterek

collectionNames

string[]

Válaszok

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Ígéretet ad vissza egy dokumentum beállítására a megadott gyűjteményben: Létrehozza a dokumentumot, ha nem létezik, ellenkező esetben frissíti a meglévő dokumentumot a megadott azonosítóval

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

Paraméterek

collectionName

string

Annak a gyűjteménynek a neve, amelyben a dokumentum található

doc

any

A tárolni kívánt dokumentum

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Ígéretet ad vissza egy beállítás mentésére a megadott kulcson és hatókörön

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

Paraméterek

key

string

Az érték mentésének kulcsa a következőhöz:

value

T

A menteni kívánt érték

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<T>

updateDocument(string, any, IDocumentOptions)

Ígéretet ad vissza egy dokumentum frissítésére a megadott gyűjteményben. A megadott azonosítóval rendelkező dokumentumnak léteznie kell

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

Paraméterek

collectionName

string

Annak a gyűjteménynek a neve, amelyben a dokumentum található

doc

any

A tárolni kívánt dokumentum

documentOptions

IDocumentOptions

Bővítménydokumentum beállításai, az alapértelmezett hatókörérték fiókszintű

Válaszok

Promise<any>