exportPresentationPdf method

Future<MultipartFile?> exportPresentationPdf(
  1. String id, {
  2. String? accountId,
  3. String? xWorkspaceID,
  4. String? storage,
  5. String? filename,
  6. ExportPDFRequest? exportPDFRequest,
})

Render the presentation as a PDF.

Proxies to the Spatio export sidecar (Playwright). Two response modes selected via ?storage=: - stream (default) — response body is the PDF binary (application/pdf). - r2 — uploads the rendered PDF to R2 storage and returns a JSON envelope with a 24-hour signed URL. Returns 503 Service Unavailable when the export sidecar is not configured (dev fallback to the client-side exporter).

Parameters:

  • String id (required): Presentation id.

  • String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with provider. If omitted on a list endpoint the call fans out across every connected account.

  • String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • String storage:

  • String filename: Sanitized base name for the downloaded PDF.

  • ExportPDFRequest exportPDFRequest:

Implementation

Future<MultipartFile?> exportPresentationPdf(String id, { String? accountId, String? xWorkspaceID, String? storage, String? filename, ExportPDFRequest? exportPDFRequest, }) async {
  final response = await exportPresentationPdfWithHttpInfo(id,  accountId: accountId, xWorkspaceID: xWorkspaceID, storage: storage, filename: filename, exportPDFRequest: exportPDFRequest, );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'MultipartFile',) as MultipartFile;

  }
  return null;
}