IExtensionDataManager interface

Balíček:

azure-devops-extension-api

Metody

createDocument(string, any, IDocumentOptions)	Vrátí příslib vytvoření dokumentu v poskytnuté kolekci
deleteDocument(string, string, IDocumentOptions)	Vrátí příslib pro odstranění dokumentu v zadaném rozsahu, kolekci a id
getDocument(string, string, IDocumentOptions)	Vrátí příslib získání dokumentu se zadaným ID v poskytnuté kolekci
getDocuments(string, IDocumentOptions)	Vrátí příslib získání všech dokumentů v poskytnuté sbírce
getValue<T>(string, IDocumentOptions)	Vrátí příslib pro načtení nastavení v zadaném klíči a rozsahu
queryCollections(ExtensionDataCollection[])	Vrátí příslib pro dotazování na sadu kolekcí
queryCollectionsByName(string[])	Vrátí příslib pro dotazování na sadu kolekcí
setDocument(string, any, IDocumentOptions)	Vrátí příslib pro nastavení dokumentu v poskytnuté kolekci Vytvoří dokument, pokud neexistuje, jinak aktualizuje existující dokument zadaným id
setValue<T>(string, T, IDocumentOptions)	Vrátí příslib uložení nastavení v zadaném klíči a rozsahu
updateDocument(string, any, IDocumentOptions)	Vrátí příslib aktualizace dokumentu v poskytnuté kolekci. Dokument se zadaným id musí existovat.

Podrobnosti metody

createDocument(string, any, IDocumentOptions)

Vrátí příslib vytvoření dokumentu v poskytnuté kolekci

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

Parametry

collectionName

string

Název kolekce, ve které se dokument nachází

doc

any

Dokument, který se má uložit

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Vrátí příslib pro odstranění dokumentu v zadaném rozsahu, kolekci a id

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

Parametry

collectionName

string

Název kolekce, ve které se dokument nachází

id

string

ID dokumentu v kolekci

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<void>

getDocument(string, string, IDocumentOptions)

Vrátí příslib získání dokumentu se zadaným ID v poskytnuté kolekci

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

Parametry

collectionName

string

Název kolekce, ve které se dokument nachází

id

string

ID dokumentu v kolekci

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<any>

getDocuments(string, IDocumentOptions)

Vrátí příslib získání všech dokumentů v poskytnuté sbírce

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

Parametry

collectionName

string

Název kolekce, ve které se dokument nachází

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Vrátí příslib pro načtení nastavení v zadaném klíči a rozsahu

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

Parametry

key

string

Klíč pro načtení hodnoty

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<T>

queryCollections(ExtensionDataCollection[])

Vrátí příslib pro dotazování na sadu kolekcí

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

Parametry

collections

ExtensionDataCollection[]

Seznam kolekcí k dotazování. Každá kolekce bude obsahovat své collectionName, scopeType a scopeValue

Návraty

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Vrátí příslib pro dotazování na sadu kolekcí

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

Parametry

collectionNames

string[]

Návraty

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Vrátí příslib pro nastavení dokumentu v poskytnuté kolekci Vytvoří dokument, pokud neexistuje, jinak aktualizuje existující dokument zadaným id

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

Parametry

collectionName

string

Název kolekce, ve které se dokument nachází

doc

any

Dokument, který se má uložit

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Vrátí příslib uložení nastavení v zadaném klíči a rozsahu

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

Parametry

key

string

Klíč pro uložení hodnoty

value

T

Hodnota, kterou je třeba uložit

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<T>

updateDocument(string, any, IDocumentOptions)

Vrátí příslib aktualizace dokumentu v poskytnuté kolekci. Dokument se zadaným id musí existovat.

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

Parametry

collectionName

string

Název kolekce, ve které se dokument nachází

doc

any

Dokument, který se má uložit

documentOptions

IDocumentOptions

Možnosti dokumentu rozšíření, výchozí hodnota rozsahu je pro celý účet

Návraty

Promise<any>