Skip to main content

.DOWNLOAD

Ermöglicht den Download von Texten und Skill-Materialien (RAGAI.DOWNLOAD).

Hintergrund

downloadMaterial/getMDContent laden das Original-Dokument eines Skills; downloadFilledPDFTemplate/downloadFilledTemplate füllen stattdessen eine Dokumentvorlage serverseitig mit Platzhalterwerten und liefern das Ergebnis als neue Datei - unterschiedliche Backend-Endpunkte, nicht nur unterschiedliche Parameter.

Methoden

.textAsFile(text, filename?)

Lädt einen Text als Datei herunter.

ParameterTypBeschreibung
textstring | z.input<typeof downloadTextAsFileSchema>Der herunterzuladende Text, oder ein Objekt gemäß downloadTextAsFileSchema.
filenamestringDer Dateiname.

Objekt-Form (validiert über downloadTextAsFileSchema):

FeldTypPflichtBeschreibung
textstringDer als Datei herunterzuladende Text.
filenamestringDer Dateiname für den Download.

Rückgabewert: void

.downloadMaterial(skillId)

Lädt das Original-Material eines Skills herunter.

ParameterTypBeschreibung
skillIdstring | z.input<typeof downloadSkillIdSchema>ID des Skills, oder ein Objekt gemäß downloadSkillIdSchema.

Objekt-Form (validiert über downloadSkillIdSchema):

FeldTypPflichtBeschreibung
skillIdstringID des Skills mit dem herunterzuladenden Material.

Rückgabewert: Promise<void>

Nichts.

.getMDContent(skillId)

Lädt den Markdown-Inhalt eines Skill-Dokuments.

ParameterTypBeschreibung
skillIdstring | z.input<typeof downloadSkillIdSchema>ID des Skills, oder ein Objekt gemäß downloadSkillIdSchema.

Objekt-Form (validiert über downloadSkillIdSchema):

FeldTypPflichtBeschreibung
skillIdstringID des Skills mit dem herunterzuladenden Material.

Rückgabewert: Promise<&#123; id: string, name: string, type: string, content: string &#125;>

Metadaten und Markdown-Inhalt des Dokuments.

.downloadFilledPDFTemplate(skillId, filename?)

Füllt eine PDF-Vorlage serverseitig aus und lädt sie herunter.

ParameterTypBeschreibung
skillIdstring | z.input<typeof downloadPdfSchema>ID des Vorlagen-Skills, oder ein Objekt gemäß downloadPdfSchema.
filenamestringDer Dateiname für den Download.

Objekt-Form (validiert über downloadPdfSchema):

FeldTypPflichtBeschreibung
skillIdstringID des Vorlagen-Skills.
filenamestringDer Dateiname für den Download.

Rückgabewert: Promise<void>

Nichts.

.downloadFilledTemplate(skillId, filename, placeholder)

Füllt eine Dokumentvorlage mit Platzhalterwerten aus und lädt sie herunter.

ParameterTypBeschreibung
skillIdstring | z.input<typeof downloadPdfSchema>ID des Vorlagen-Skills, oder ein Objekt gemäß downloadPdfSchema.
filenamestringDer Dateiname für den Download.
placeholderobjectPlatzhalter-Werte für die Vorlage.

Objekt-Form (validiert über downloadPdfSchema):

FeldTypPflichtBeschreibung
skillIdstringID des Vorlagen-Skills.
filenamestringDer Dateiname für den Download.

Rückgabewert: Promise<void>

Nichts.