IExtensionDataManager interface

Paket:

azure-devops-extension-api

Metoder

createDocument(string, any, IDocumentOptions)	Returnerar ett löfte om att skapa ett dokument i den angivna samlingen
deleteDocument(string, string, IDocumentOptions)	Returnerar ett löfte om att ta bort dokumentet i det angivna omfånget, samlingen och ID:t
getDocument(string, string, IDocumentOptions)	Returnerar ett löfte om att få ett dokument med det angivna ID:t i den angivna samlingen
getDocuments(string, IDocumentOptions)	Returnerar ett löfte om att hämta alla dokument i den angivna samlingen
getValue<T>(string, IDocumentOptions)	Returnerar ett löfte om att hämta en inställning i den angivna nyckeln och omfånget
queryCollections(ExtensionDataCollection[])	Returnerar ett löfte om att köra frågor mot en uppsättning samlingar
queryCollectionsByName(string[])	Returnerar ett löfte om att köra frågor mot en uppsättning samlingar
setDocument(string, any, IDocumentOptions)	Returnerar ett löfte om att ange ett dokument i den angivna samlingen Skapar dokumentet om det inte finns, annars uppdateras det befintliga dokumentet med det angivna ID:t
setValue<T>(string, T, IDocumentOptions)	Returnerar ett löfte om att spara en inställning i den angivna nyckeln och omfånget
updateDocument(string, any, IDocumentOptions)	Returnerar ett löfte om att uppdatera ett dokument i den angivna samlingen Ett dokument med det angivna ID:t måste finnas

Metodinformation

createDocument(string, any, IDocumentOptions)

Returnerar ett löfte om att skapa ett dokument i den angivna samlingen

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

Parametrar

collectionName

string

Namnet på samlingen där dokumentet finns

doc

any

Dokumentet som ska lagras

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Returnerar ett löfte om att ta bort dokumentet i det angivna omfånget, samlingen och ID:t

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

Parametrar

collectionName

string

Namnet på samlingen där dokumentet finns

id

string

ID:t för dokumentet i samlingen

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<void>

getDocument(string, string, IDocumentOptions)

Returnerar ett löfte om att få ett dokument med det angivna ID:t i den angivna samlingen

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

Parametrar

collectionName

string

Namnet på samlingen där dokumentet finns

id

string

ID:t för dokumentet i samlingen

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<any>

getDocuments(string, IDocumentOptions)

Returnerar ett löfte om att hämta alla dokument i den angivna samlingen

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

Parametrar

collectionName

string

Namnet på samlingen där dokumentet finns

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Returnerar ett löfte om att hämta en inställning i den angivna nyckeln och omfånget

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

Parametrar

key

string

Nyckeln för att hämta ett värde för

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<T>

queryCollections(ExtensionDataCollection[])

Returnerar ett löfte om att köra frågor mot en uppsättning samlingar

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

Parametrar

collections

ExtensionDataCollection[]

Listan över samlingar att fråga efter. Varje samling innehåller dess collectionName, scopeType och scopeValue

Returer

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Returnerar ett löfte om att köra frågor mot en uppsättning samlingar

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

Parametrar

collectionNames

string[]

Returer

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Returnerar ett löfte om att ange ett dokument i den angivna samlingen Skapar dokumentet om det inte finns, annars uppdateras det befintliga dokumentet med det angivna ID:t

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

Parametrar

collectionName

string

Namnet på samlingen där dokumentet finns

doc

any

Dokumentet som ska lagras

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Returnerar ett löfte om att spara en inställning i den angivna nyckeln och omfånget

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

Parametrar

key

string

Nyckeln för att spara ett värde för

value

T

Värdet som ska sparas

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<T>

updateDocument(string, any, IDocumentOptions)

Returnerar ett löfte om att uppdatera ett dokument i den angivna samlingen Ett dokument med det angivna ID:t måste finnas

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

Parametrar

collectionName

string

Namnet på samlingen där dokumentet finns

doc

any

Dokumentet som ska lagras

documentOptions

IDocumentOptions

Alternativ för tilläggsdokument. Standardvärdet för omfånget är kontoomfattande

Returer

Promise<any>