IExtensionDataManager interface

Pacote:

azure-devops-extension-api

Métodos

createDocument(string, any, IDocumentOptions)	Retorna uma promessa para criar um documento na coleção fornecida
deleteDocument(string, string, IDocumentOptions)	Retorna uma promessa para excluir o documento no escopo, coleção e id fornecidos
getDocument(string, string, IDocumentOptions)	Retorna uma promessa para obter um documento com a ID fornecida na coleção fornecida
getDocuments(string, IDocumentOptions)	Retorna uma promessa para obter todos os documentos na coleção fornecida
getValue<T>(string, IDocumentOptions)	Retorna uma promessa para recuperar uma configuração na chave e no escopo fornecidos
queryCollections(ExtensionDataCollection[])	Retorna uma promessa para consultar um conjunto de coleções
queryCollectionsByName(string[])	Retorna uma promessa para consultar um conjunto de coleções
setDocument(string, any, IDocumentOptions)	Retorna uma promessa para definir um documento na coleção fornecida Cria o documento se ele não existir, caso contrário, atualiza o documento existente com a id fornecida
setValue<T>(string, T, IDocumentOptions)	Retorna uma promessa para salvar uma configuração na chave e no escopo fornecidos
updateDocument(string, any, IDocumentOptions)	Retorna uma promessa para atualizar um documento na coleção fornecida Um documento com a id fornecida deve existir

Detalhes do método

createDocument(string, any, IDocumentOptions)

Retorna uma promessa para criar um documento na coleção fornecida

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

Parâmetros

collectionName

string

O nome da coleção em que o documento reside

doc

any

O documento a ser armazenado

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Retorna uma promessa para excluir o documento no escopo, coleção e id fornecidos

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

Parâmetros

collectionName

string

O nome da coleção em que o documento reside

id

string

A ID do documento na coleção

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<void>

getDocument(string, string, IDocumentOptions)

Retorna uma promessa para obter um documento com a ID fornecida na coleção fornecida

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

Parâmetros

collectionName

string

O nome da coleção em que o documento reside

id

string

A ID do documento na coleção

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<any>

getDocuments(string, IDocumentOptions)

Retorna uma promessa para obter todos os documentos na coleção fornecida

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

Parâmetros

collectionName

string

O nome da coleção em que o documento reside

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Retorna uma promessa para recuperar uma configuração na chave e no escopo fornecidos

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

Parâmetros

key

string

A chave para recuperar um valor para

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<T>

queryCollections(ExtensionDataCollection[])

Retorna uma promessa para consultar um conjunto de coleções

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

Parâmetros

collections

ExtensionDataCollection[]

A lista de coleções a serem consultadas. Cada coleção conterá seu collectionName, scopeType e scopeValue

Retornos

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Retorna uma promessa para consultar um conjunto de coleções

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

Parâmetros

collectionNames

string[]

Retornos

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Retorna uma promessa para definir um documento na coleção fornecida Cria o documento se ele não existir, caso contrário, atualiza o documento existente com a id fornecida

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

Parâmetros

collectionName

string

O nome da coleção em que o documento reside

doc

any

O documento a ser armazenado

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Retorna uma promessa para salvar uma configuração na chave e no escopo fornecidos

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

Parâmetros

key

string

A chave para salvar um valor

value

T

O valor a ser salvo

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<T>

updateDocument(string, any, IDocumentOptions)

Retorna uma promessa para atualizar um documento na coleção fornecida Um documento com a id fornecida deve existir

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

Parâmetros

collectionName

string

O nome da coleção em que o documento reside

doc

any

O documento a ser armazenado

documentOptions

IDocumentOptions

Opções de documento de extensão, o valor de escopo padrão é para toda a conta

Retornos

Promise<any>