getFile method

Future<RestApiFileResponse> getFile(
  1. String oid
)

Lädt eine Datei anhand ihrer Objekt-ID herunter

Ruft den Dateiinhalt und die Metadaten einer gespeicherten Datei ab. Die Methode prüft automatisch die Session und lädt dann die vollständige Datei.

oid - Die eindeutige Objekt-ID der Datei

Returns: RestApiFileResponse mit Dateiinhalt, MIME-Type und Metadaten

Throws: Exception bei Netzwerkfehlern oder ungültiger OID

Beispiel:

try {
  RestApiFileResponse response = await api.v1.documents.getFile("file-oid-12345");
  if (response.isOk) {
    Uint8List fileData = response.data;
    String fileName = response.fileName;
    String mimeType = response.mimeType;
    // Datei speichern oder verarbeiten
  }
} catch (e) {
  print("Datei-Download fehlgeschlagen: $e");
}

Implementation

Future<RestApiFileResponse> getFile(String oid) {
  return _runtime.execute(
    ApiRequest<RestApiFileResponse>(
      method: ApiHttpMethod.get,
      version: ApiVersion.v1,
      path: '/file/$oid',
      authentication: AuthenticationPolicy.session,
      responsePolicy: _fileResponsePolicy,
      operationId: 'v1.documents.getFile',
    ),
  );
}