navidev-adt-api
Version:
API de conexión al Abap Developer Tools
62 lines • 3.06 kB
TypeScript
import { LogonData } from "../adtConnection/adtConnection";
import { ResponseRepositoryTypesStructure, ResponseRepositoryObjectTypes, ResponseRepositoryCheckRuns, ResponseRepositoryObjectType, ResponseRepositoryTypeStructure, ResponseRepositorySearchMetadata, ResponseRepositorySearchObject } from "./repositoryTypes";
export * from "./repositoryTypes";
export declare class AdtRepository {
private repositoryApp;
private connectionController;
constructor(logonData: LogonData);
/**
* Devuelve la estructura de nodos de ADT. Los objetos del arbol de Eclipse o SE80
* @param ignoreCache | Ignorar cache
* @returns Result con la lista de valores o Errores
*/
readTypesStructure(ignoreCache?: boolean): Promise<ResponseRepositoryTypesStructure>;
/**
* Devuelve la lista de tipos de objeto del repositorio
* @param ignoreCache | Ignorar cache
* @returns Result con la lista de valores o Errores
*/
readObjectTypes(ignoreCache?: boolean): Promise<ResponseRepositoryObjectTypes>;
/**
* Devuelve los objetos los cuales se puede lanzar el servicio de validación o compilación
* @returns Result con la lista de valores o Errores
*/
repositoryCheckRun(): Promise<ResponseRepositoryCheckRuns>;
/**
* Devuelve el tipo de objeto a partir del nombre.
* Se usa en sitios como leer el contenido de un paquete, donde
* se le pasa el nombre técnico.
* @param name
* @returns Resultado con el objeto técnico
*/
getObjectTypeFromObjectName(name: string): Promise<ResponseRepositoryObjectType>;
/**
* Devuelve la definición del tipo de objeto a partir de su nombre
* @param name | Nombre del objeto
* @returns Datos del tipo de objeto
*/
getTypeFromObjectType(name: string): Promise<ResponseRepositoryTypeStructure>;
/**
* Devuelve las combinaciones de los objetos que se pueden usar para buscar.
* @param searchQuery Texto a buscar, aunque realmente si no se informa nada devuelve lo mismo
* @returns Array con la combinacion de objetos y descripciones a buscar
*/
searchMetadata(searchQuery?: string): Promise<ResponseRepositorySearchMetadata>;
/**
* Busqueda individual de objetos, es decir, por un tipo y subtipo de objetos
* @param objectType Tipo de objeto
* @param legacyType Subtipo de objeto
* @param searchQuery Objeto a buscar
* @returns Resultado de la búsqueda
*/
searchObjectSingleType(objectType: string, legacyType: string, searchQuery: string): Promise<ResponseRepositorySearchObject>;
/**
* Busqueda rápida de objeto. Indicando el objeto su patrón y el tipo de objeto.
* @param objectType Tipo de objeto
* @param searchQuery Objeto a buscar
* @param maxResults Numero máximo de resultados
* @returns Resultado de la búsqueda
*/
quickSearch(searchQuery: string, objectType?: string, maxResults?: number): Promise<ResponseRepositorySearchObject>;
}
//# sourceMappingURL=adtRepository.d.ts.map