RestApiDOCUframeConfig class

Erweiterte Konfigurationsklasse für DOCUframe REST-API-Parameter

Diese Klasse erweitert RestApiConfig und kapselt alle DOCUframe-spezifischen Konfigurationseinstellungen für den RestApiDOCUframeManager:

  • Authentifizierungseinstellungen (App-Key, Benutzername, Anwendungsnamen)
  • Buffer-Einstellungen für Multi-Requests und Batch-Verarbeitung
  • Session-Management und Login-Konfigurationen (v2-Login, 2FA)
  • Paginierungs- und Performance-Einstellungen
  • Zusätzlich zu den Basis-Einstellungen (Server, SSL, Timeouts)

Die Klasse erweitert die Basis-Funktionalität um DOCUframe-spezifische Konfigurationsmöglichkeiten und bietet vollständige API-Konfiguration.

Vorteile:

  • Zentrale Verwaltung aller DOCUframe-Konfigurationswerte
  • Typ-sichere erweiterte Konfiguration
  • Einfache Validierung und Default-Werte
  • Bessere Testbarkeit durch isolierte Konfiguration
  • Dynamische Konfigurationsänderungen zur Laufzeit
Inheritance

Constructors

RestApiDOCUframeConfig({required String appKey, required String userName, required List<String> appNames, required String serverUrl, required String alias, RestApiDevice? device, int perPageCount = 50, int bufferFlushDelayMs = 100, int maxBufferSize = 10, bool useBase64UrlParameter = false, bool useFolderPathEncoding = false, bool allowSslError = false, bool debugLogs = false, bool multiRequest = false, String sessionId = ""})
Konstruktor für RestApiConfig

Properties

additionalAppNames ↔ List<String>
Zusätzliche Anwendungsnamen (können dynamisch hinzugefügt werden)
getter/setter pair
alias → String
Datenbank-Alias für Multi-Datenbank-Umgebungen Beispiel: dfapp
finalinherited
allowSslError ↔ bool
Erlaubt SSL-Zertifikatsfehler (nur für Development)
getter/setter pairinherited
appKey → String
App-Schlüssel für die API-Authentifizierung Beispiel: GSD-DFApp
final
appNames ↔ List<String>
Liste der Anwendungsnamen Beispiel: ['GSD-RestApi', 'GSD-DFApp']
getter/setter pair
bufferFlushDelayMs → int
no setter
connectionTimeout → Duration
Timeout für HTTP-Verbindungsaufbau (5 Sekunden)
finalinherited
debugLogs ↔ bool
Aktiviert detaillierte Debug-Logs (nur für Development)
getter/setter pairinherited
device ↔ RestApiDevice?
Optionales Gerät für die Anmeldung (Push-Benachrichtigungen)
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
maxBufferSize → int
no setter
multiRequest ↔ bool
Aktiviert Multi-Request-Modus für Batch-Verarbeitung ab GSD-Connect Version 1.0.0.30
getter/setter pair
perPageCount → int
no setter
responseTimeout → Duration
Timeout für HTTP-Antworten (10 Minuten)
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverUrl → String
Server-URL mit Protokoll, IP und Port Beispiel: https://127.0.0.1:8080
finalinherited
sessionId ↔ String
Aktuelle Session-ID (wird vom Auth-System verwaltet)
getter/setter pair
useBase64UrlParameter ↔ bool
Verwendet Base64-kodierte URL-Parameter für Anfragen ab GSD-Connect Version 1.0.0.29
getter/setter pair
useFolderPathEncoding ↔ bool
Verwendet Ordnerpfad-Codierung für Pfad-Parameter in API-Aufrufen
getter/setter pair
userName → String
Benutzername für die Anmeldung Beispiel: GSDAdmin
final

Methods

getAllAppNames() → List<String>
Gibt die vollständige Liste aller App-Namen zurück
getHeaders({String contentType = "application/json; charset=utf-8", bool addAppKey = true, bool addSessionId = true}) → Map<String, String>
Erstellt HTTP-Header für API-Anfragen
getUri(String path, {Map<String, String>? params}) → Uri
Erstellt eine URI für API-Aufrufe
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setAllowSslError(bool allowSslError) → void
Setzt SSL-Fehler-Toleranz
inherited
setBufferFlushDelayMs(int bufferFlushDelayMs) → void
Setzt Buffer-Flush-Delay
setMaxBufferSize(int maxBufferSize) → void
Setter-Methoden für dynamische Konfigurationsänderungen Setzt maximale Buffer-Größe
setPerPageCount(int perPageCount) → void
Setzt per-Page-Count für Paginierung
toString() → String
String-Repräsentation der Konfiguration
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited