IExtensionDataManager interface

Paquete:

azure-devops-extension-api

Métodos

createDocument(string, any, IDocumentOptions)	Devuelve una promesa para crear un documento en la colección proporcionada
deleteDocument(string, string, IDocumentOptions)	Devuelve una promesa para eliminar el documento en el ámbito, la colección y el identificador proporcionados
getDocument(string, string, IDocumentOptions)	Devuelve una promesa para obtener un documento con el identificador proporcionado en la colección proporcionada
getDocuments(string, IDocumentOptions)	Devuelve una promesa para obtener todos los documentos de la colección proporcionada
getValue<T>(string, IDocumentOptions)	Devuelve una promesa para recuperar una configuración en la clave y el ámbito proporcionados
queryCollections(ExtensionDataCollection[])	Devuelve una promesa para consultar un conjunto de colecciones
queryCollectionsByName(string[])	Devuelve una promesa para consultar un conjunto de colecciones
setDocument(string, any, IDocumentOptions)	Devuelve una promesa para establecer un documento en la colección proporcionada Crea el documento si no existe, de lo contrario actualiza el documento existente con el identificador proporcionado
setValue<T>(string, T, IDocumentOptions)	Devuelve una promesa para guardar una configuración en la clave y el ámbito proporcionados
updateDocument(string, any, IDocumentOptions)	Devuelve una promesa para actualizar un documento en la colección proporcionada Debe existir un documento con el identificador proporcionado

Detalles del método

createDocument(string, any, IDocumentOptions)

Devuelve una promesa para crear un documento en la colección proporcionada

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

Parámetros

collectionName

string

El nombre de la colección donde se encuentra el documento

doc

any

El documento a almacenar

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<any>

deleteDocument(string, string, IDocumentOptions)

Devuelve una promesa para eliminar el documento en el ámbito, la colección y el identificador proporcionados

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

Parámetros

collectionName

string

El nombre de la colección donde se encuentra el documento

id

string

El identificador del documento de la colección

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<void>

getDocument(string, string, IDocumentOptions)

Devuelve una promesa para obtener un documento con el identificador proporcionado en la colección proporcionada

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

Parámetros

collectionName

string

El nombre de la colección donde se encuentra el documento

id

string

El identificador del documento de la colección

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<any>

getDocuments(string, IDocumentOptions)

Devuelve una promesa para obtener todos los documentos de la colección proporcionada

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

Parámetros

collectionName

string

El nombre de la colección donde se encuentra el documento

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<any[]>

getValue<T>(string, IDocumentOptions)

Devuelve una promesa para recuperar una configuración en la clave y el ámbito proporcionados

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

Parámetros

key

string

La clave para recuperar un valor para

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<T>

queryCollections(ExtensionDataCollection[])

Devuelve una promesa para consultar un conjunto de colecciones

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

Parámetros

collections

ExtensionDataCollection[]

La lista de colecciones que se van a consultar. Cada colección contendrá su collectionName, scopeType y scopeValue

Devoluciones

Promise<ExtensionDataCollection[]>

queryCollectionsByName(string[])

Devuelve una promesa para consultar un conjunto de colecciones

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

Parámetros

collectionNames

string[]

Devoluciones

Promise<ExtensionDataCollection[]>

setDocument(string, any, IDocumentOptions)

Devuelve una promesa para establecer un documento en la colección proporcionada Crea el documento si no existe, de lo contrario actualiza el documento existente con el identificador proporcionado

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

Parámetros

collectionName

string

El nombre de la colección donde se encuentra el documento

doc

any

El documento a almacenar

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<any>

setValue<T>(string, T, IDocumentOptions)

Devuelve una promesa para guardar una configuración en la clave y el ámbito proporcionados

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

Parámetros

key

string

La clave para guardar un valor para

value

T

El valor a ahorrar

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<T>

updateDocument(string, any, IDocumentOptions)

Devuelve una promesa para actualizar un documento en la colección proporcionada Debe existir un documento con el identificador proporcionado

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

Parámetros

collectionName

string

El nombre de la colección donde se encuentra el documento

doc

any

El documento a almacenar

documentOptions

IDocumentOptions

Opciones de documento de extensión, el valor de alcance predeterminado es para toda la cuenta

Devoluciones

Promise<any>