IExtensionDataManager interface

Paket:

azure-devops-extension-api

Methoden

createDocument(string, any, IDocumentOptions)	Gibt eine Zusage für das Erstellen eines Dokuments in der bereitgestellten Auflistung zurück
deleteDocument(string, string, IDocumentOptions)	Gibt eine Zusage für das Löschen des Dokuments im angegebenen Bereich, in der Sammlung und in der ID zurück
getDocument(string, string, IDocumentOptions)	Gibt eine Zusage für das Abrufen eines Dokuments mit der angegebenen ID in der bereitgestellten Auflistung zurück
getDocuments(string, IDocumentOptions)	Gibt eine Zusage für das Abrufen aller Dokumente in der bereitgestellten Sammlung zurück
getValue<T>(string, IDocumentOptions)	Gibt eine Zusage für das Abrufen einer Einstellung mit dem angegebenen Schlüssel und Bereich zurück
queryCollections(ExtensionDataCollection[])	Gibt eine Zusage für die Abfrage einer Gruppe von Auflistungen zurück
queryCollectionsByName(string[])	Gibt eine Zusage für die Abfrage einer Gruppe von Auflistungen zurück
setDocument(string, any, IDocumentOptions)	Gibt eine Zusage für das Festlegen eines Dokuments in der bereitgestellten Auflistung zurück Erstellt das Dokument, wenn es nicht vorhanden ist, andernfalls wird das vorhandene Dokument mit der angegebenen ID aktualisiert
setValue<T>(string, T, IDocumentOptions)	Gibt eine Zusage für das Speichern einer Einstellung mit dem angegebenen Schlüssel und Bereich zurück
updateDocument(string, any, IDocumentOptions)	Gibt eine Zusage für das Aktualisieren eines Dokuments in der bereitgestellten Auflistung zurück. Ein Dokument mit der angegebenen ID muss vorhanden sein.

Details zur Methode

createDocument(string, any, IDocumentOptions)

Gibt eine Zusage für das Erstellen eines Dokuments in der bereitgestellten Auflistung zurück

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

Parameter

collectionName

string

Der Name der Sammlung, in der sich das Dokument befindet

doc

any

Das zu speichernde Dokument

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Gibt eine Zusage für das Löschen des Dokuments im angegebenen Bereich, in der Sammlung und in der ID zurück

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

Parameter

collectionName

string

Der Name der Sammlung, in der sich das Dokument befindet

id

string

Die ID des Dokuments in der Sammlung

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<void>

getDocument(string, string, IDocumentOptions)

Gibt eine Zusage für das Abrufen eines Dokuments mit der angegebenen ID in der bereitgestellten Auflistung zurück

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

Parameter

collectionName

string

Der Name der Sammlung, in der sich das Dokument befindet

id

string

Die ID des Dokuments in der Sammlung

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<any>

getDocuments(string, IDocumentOptions)

Gibt eine Zusage für das Abrufen aller Dokumente in der bereitgestellten Sammlung zurück

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

Parameter

collectionName

string

Der Name der Sammlung, in der sich das Dokument befindet

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Gibt eine Zusage für das Abrufen einer Einstellung mit dem angegebenen Schlüssel und Bereich zurück

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

Parameter

key

string

Der Schlüssel, für den ein Wert abgerufen werden soll

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<T>

queryCollections(ExtensionDataCollection[])

Gibt eine Zusage für die Abfrage einer Gruppe von Auflistungen zurück

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

Parameter

collections

ExtensionDataCollection[]

Die Liste der Sammlungen, die abgefragt werden sollen. Jede Auflistung enthält ihren collectionName, scopeType und scopeValue

Gibt zurück

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Gibt eine Zusage für die Abfrage einer Gruppe von Auflistungen zurück

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

Parameter

collectionNames

string[]

Gibt zurück

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Gibt eine Zusage für das Festlegen eines Dokuments in der bereitgestellten Auflistung zurück Erstellt das Dokument, wenn es nicht vorhanden ist, andernfalls wird das vorhandene Dokument mit der angegebenen ID aktualisiert

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

Parameter

collectionName

string

Der Name der Sammlung, in der sich das Dokument befindet

doc

any

Das zu speichernde Dokument

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Gibt eine Zusage für das Speichern einer Einstellung mit dem angegebenen Schlüssel und Bereich zurück

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

Parameter

key

string

Der Schlüssel, für den ein Wert gespeichert werden soll

value

T

Der Wert, der gespeichert werden soll

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<T>

updateDocument(string, any, IDocumentOptions)

Gibt eine Zusage für das Aktualisieren eines Dokuments in der bereitgestellten Auflistung zurück. Ein Dokument mit der angegebenen ID muss vorhanden sein.

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

Parameter

collectionName

string

Der Name der Sammlung, in der sich das Dokument befindet

doc

any

Das zu speichernde Dokument

documentOptions

IDocumentOptions

Optionen für Erweiterungsdokumente, der Standardwert für den Geltungsbereich gilt für den gesamten Account

Gibt zurück

Promise<any>