foo-webview-sdk
    Preparing search index...

    Interface HttpDownloadCompletePayload

    Payload of the http:downloadComplete event. The outcome of http.download with async: true, carrying the receipt's requestId. On success it has the fields of a synchronous download; on failure error and code. Delivered like http:response.

    interface HttpDownloadCompletePayload {
        bytesWritten?: number;
        cancelled?: boolean;
        code?:
            | "INVALID_PARAMS"
            | "OPERATION_FAILED"
            | "CANCELLED"
            | "PERMISSION_DENIED";
        error?: string;
        path?: string;
        requestId: string;
        status?: number;
        success: boolean;
    }
    Index
    bytesWritten? cancelled? code? error? path? requestId status? success
    bytesWritten?: number

    Bytes written; present on success.

    cancelled?: boolean

    true when the download was cancelled by http.abort; absent otherwise.

    code?: "INVALID_PARAMS" | "OPERATION_FAILED" | "CANCELLED" | "PERMISSION_DENIED"

    The error code, as in http:response. Present on failure.

    error?: string

    Why the download failed; present on failure.

    path?: string

    The file written, with path variables expanded; present on success.

    requestId: string

    Id from the receipt.

    status?: number

    HTTP status code: on success that of the response; on failure only when a redirect was refused under redirect: "error", that of the redirect.

    success: boolean

    Whether the file was written. A response with an error status such as 404 is saved and counts as a success.

    Settings
    Member Visibility

    On This Page
    Properties