IExtensionDataManager interface

Pacchetto:

azure-devops-extension-api

Metodi

createDocument(string, any, IDocumentOptions)	Restituisce una promessa per la creazione di un documento nella raccolta fornita
deleteDocument(string, string, IDocumentOptions)	Restituisce una promessa per l'eliminazione del documento nell'ambito, nella raccolta e nell'id specificati
getDocument(string, string, IDocumentOptions)	Restituisce una promessa per l'ottenimento di un documento con l'ID fornito nella raccolta fornita
getDocuments(string, IDocumentOptions)	Restituisce una promessa per l'ottenimento di tutti i documenti nella raccolta fornita
getValue<T>(string, IDocumentOptions)	Restituisce una promessa per il recupero di un'impostazione nella chiave e nell'ambito specificati
queryCollections(ExtensionDataCollection[])	Restituisce una promessa per l'esecuzione di query su un set di raccolte
queryCollectionsByName(string[])	Restituisce una promessa per l'esecuzione di query su un set di raccolte
setDocument(string, any, IDocumentOptions)	Restituisce una promessa per l'impostazione di un documento nella raccolta fornita Crea il documento se non esiste, altrimenti aggiorna il documento esistente con l'id fornito
setValue<T>(string, T, IDocumentOptions)	Restituisce una promessa per il salvataggio di un'impostazione nella chiave e nell'ambito specificati
updateDocument(string, any, IDocumentOptions)	Restituisce una promessa per l'aggiornamento di un documento nella raccolta fornita Deve esistere un documento con l'ID fornito

Dettagli metodo

createDocument(string, any, IDocumentOptions)

Restituisce una promessa per la creazione di un documento nella raccolta fornita

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

Parametri

collectionName

string

Il nome della collezione in cui risiede il documento

doc

any

Il documento da archiviare

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Restituisce una promessa per l'eliminazione del documento nell'ambito, nella raccolta e nell'id specificati

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

Parametri

collectionName

string

Il nome della collezione in cui risiede il documento

id

string

L'ID del documento nella raccolta

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<void>

getDocument(string, string, IDocumentOptions)

Restituisce una promessa per l'ottenimento di un documento con l'ID fornito nella raccolta fornita

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

Parametri

collectionName

string

Il nome della collezione in cui risiede il documento

id

string

L'ID del documento nella raccolta

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<any>

getDocuments(string, IDocumentOptions)

Restituisce una promessa per l'ottenimento di tutti i documenti nella raccolta fornita

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

Parametri

collectionName

string

Il nome della collezione in cui risiede il documento

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Restituisce una promessa per il recupero di un'impostazione nella chiave e nell'ambito specificati

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

Parametri

key

string

La chiave per cui recuperare un valore

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<T>

queryCollections(ExtensionDataCollection[])

Restituisce una promessa per l'esecuzione di query su un set di raccolte

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

Parametri

collections

ExtensionDataCollection[]

Elenco delle raccolte su cui eseguire query. Ogni raccolta conterrà i relativi collectionName, scopeType e scopeValue

Restituisce

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Restituisce una promessa per l'esecuzione di query su un set di raccolte

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

Parametri

collectionNames

string[]

Restituisce

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Restituisce una promessa per l'impostazione di un documento nella raccolta fornita Crea il documento se non esiste, altrimenti aggiorna il documento esistente con l'id fornito

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

Parametri

collectionName

string

Il nome della collezione in cui risiede il documento

doc

any

Il documento da archiviare

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Restituisce una promessa per il salvataggio di un'impostazione nella chiave e nell'ambito specificati

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

Parametri

key

string

La chiave per salvare un valore

value

T

Il valore da risparmiare

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<T>

updateDocument(string, any, IDocumentOptions)

Restituisce una promessa per l'aggiornamento di un documento nella raccolta fornita Deve esistere un documento con l'ID fornito

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

Parametri

collectionName

string

Il nome della collezione in cui risiede il documento

doc

any

Il documento da archiviare

documentOptions

IDocumentOptions

Opzioni del documento di estensione, il valore predefinito dell'ambito è a livello di account

Restituisce

Promise<any>