CupThread React Native & Expo SDK - v0.1.0
    Preparing search index...

    Interface UploadAttachmentOptions

    Options for uploading binary or media attachments via FeedbackClient.uploadAttachment.

    const options: UploadAttachmentOptions = {
      file: { uri: 'file:///var/mobile/.../screenshot.png' },
      filename: 'screenshot.png',
      mimeType: 'image/png',
      preferredKind: 'image',
    };
    interface UploadAttachmentOptions {
        file: any;
        filename: string;
        mimeType: string;
        preferredKind?: "image" | "r2";
        signal?: AbortSignal;
        timeoutMs?: number;
        userToken?: string;
    }
    Index
    file filename mimeType preferredKind? signal? timeoutMs? userToken?
    file: any

    File payload to upload. In React Native, this can be an object containing { uri, name, type } or a standard Blob/File.

    filename: string

    Name of the file including file extension (e.g. 'crash-log.txt').

    mimeType: string

    Content MIME type of the upload (e.g. 'image/png', 'text/plain').

    preferredKind?: "image" | "r2"

    Preferred storage destination:

    • 'image': Routed to optimized image processing pipeline.
    • 'r2': Routed to Cloudflare R2 object storage for logs or diagnostic archives.

    'image' if mimeType starts with 'image/', else 'r2'

    signal?: AbortSignal

    Optional abort signal to cancel the upload operation.

    timeoutMs?: number

    Optional completion-budget override in milliseconds for this upload. Falls back to uploadTimeoutMs from the client config, which defaults to 60 seconds — uploads do not inherit the shorter JSON-request timeoutMs.

    userToken?: string

    Optional persistent user token sent as the X-User-Token header so the upload can be attributed to the uploading user, matching every other authenticated API call.

    Settings
    Member Visibility

    On This Page
    Properties