Zum Hauptinhalt springen

API

constructor​

new FileSearch(options: FileSearchOptions): FileSearch

Beispiel:

context.enableModules();
const { FileSearch } = require("ou.sp.gadget.FileSearch");

const gadget = new FileSearch({
    id: "test",
    fileTypes: ["testMappe1"],
    searchFields: ["Belegnummer"],
});
context.returnValue = gadget.transfer();

Erweitertes Beispiel:

context.enableModules();
const { FileSearch } = require("ou.sp.gadget.FileSearch");

const gadget =  new FileSearch({
    id: "test",
    searchScript: "ou.cust.callback.fileSearch",
    // Mappentypen hier anpassen
    fileTypes: [
        "testMappe1",
        "testMappe2"
    ],
    // Mappenfelder die durchsucht werden sollen
    searchFields: [
        "Belegart",
        "Belegnummer",
        "Belegdatum",
        "Handelspartnernummer",
        "Auftragsnummer"
    ],
    // Zusätzliche Schaltfläche
    params: {
        optionalFlag: {
            type: "checkbox",
            label: "Mit Admin-Rechten suchen?",
            value: true,
        },
    }
});
context.returnValue = gadget.transfer();

Statische Funktionen​

getParams: Object​

FileSearch.getParams(rows: Object[]): FileSearchCallbackSearchOptions | undefined

Beispiel:

context.enableModules();
const { FileSearch } = require("ou.sp.gadget.FileSearch");

const options = FileSearch.getParams()
// options.value
// options.customParams
// options.searchParams[0].field
// options.searchParams[0].value

getSearchFilter: string​

FileSearch.getSearchFilter(searchOptions?: FileSearchCallbackSearchOptions, searchMethod?: searchMethod, searchCombination: string = "OR"): string

searchMethod:

  • contains = 0
  • exact = 1
  • startsWith = 2
context.enableModules();
const { FileSearch } = require("ou.sp.gadget.FileSearch");

const options = FileSearch.getParams()
const filter = FileSearch.getSearchFilter(options, 2, "AND")
context.returnValue = FileSearch.showSearchFolder({
    gadgetId: options.id,
    title: options.title,
    filter: filter,
    fileTypes: options.fileTypes,
    archiveViews: options.archiveViews,
})

showSearchFolder: string​

FileSearch.showSearchFolder(options: SearchFolderOptions): string
  • Setzt den context.returnType auf showFolder
  • Gibt die Ordner-Id zurück

Beispiel:

context.enableModules();
const { FileSearch } = require("ou.sp.gadget.FileSearch");

const options = FileSearch.getParams()
const filter = "test ~ '1'"
context.returnValue = FileSearch.showSearchFolder({
    gadgetId: options.id,
    title: options.title,
    filter: filter,
    fileTypes: options.fileTypes,
    archiveViews: options.archiveViews,
})

showFile: string​

FileSearch.showFile(fileId): string
  • Setzt den context.returnType auf showFile
  • Gibt die Ordner-Id zurück

Beispiel:

context.enableModules();
const { FileSearch } = require("ou.sp.gadget.FileSearch");

const docFile = context.file
context.returnValue = FileSearch.showFile(docFile.id)

Instanz Funktionen​

transfer: string​

transfer(): string

Gibt das FileSearch-Gadget am Client zurück.

Beispiel:

context.enableModules();
const { FileSearch } = require("ou.sp.gadget.FileSearch");

const fileSearch new FileSearch({
    id: "test",
    fileTypes: ["testMappe1"],
    searchFields: ["Belegnummer"],
})

context.returnValue = fileSearch.transfer()