Bulk Data Client
    Preparing search index...

    Interface BulkDataClientEvents

    The BulkDataClient instances emit the following events:

    interface BulkDataClientEvents {
        abort: (this: BulkDataClient) => void;
        allDownloadsComplete: (
            this: BulkDataClient,
            downloads: Types.BulkDataClient.FileDownload[],
        ) => void;
        authorize: (this: BulkDataClient, accessToken: string) => void;
        downloadComplete: (
            this: BulkDataClient,
            detail: {
                fileSize: number;
                fileUrl: string;
                resourceCount: number | null;
            },
        ) => void;
        downloadError: (
            this: BulkDataClient,
            details: {
                body: string | OperationOutcome | null;
                code: number | null;
                fileUrl: string;
                message?: string;
                responseHeaders?: ResponseHeaders;
            },
        ) => void;
        downloadProgress: (
            this: BulkDataClient,
            downloads: Types.BulkDataClient.FileDownload[],
        ) => void;
        downloadStart: (
            this: BulkDataClient,
            detail: { fileUrl: string; itemType: string; resourceType: string | null },
        ) => void;
        error: (this: BulkDataClient, error: Error) => void;
        exportComplete: (this: BulkDataClient, manifest: ExportManifest) => void;
        exportError: (
            this: BulkDataClient,
            details: {
                body: string | OperationOutcome | null;
                code: number | null;
                message?: string;
                responseHeaders?: ResponseHeaders;
            },
        ) => void;
        exportPage: (
            this: BulkDataClient,
            page: ExportManifest,
            url: string,
        ) => void;
        exportProgress: (this: BulkDataClient, status: ExportStatus) => void;
        exportStart: (this: BulkDataClient, status: ExportStatus) => void;
        kickOffEnd: (
            this: BulkDataClient,
            data: {
                capabilityStatement: CapabilityStatement;
                requestParameters: Record<string, any>;
                response: Response;
                responseHeaders?: ResponseHeaders;
            },
        ) => void;
        kickOffStart: (
            this: BulkDataClient,
            requestOptions: OptionsOfUnknownResponseBody,
        ) => void;
        manifestComplete: (this: BulkDataClient, transactionTime: string) => void;
    }
    Index
    exportError
    abort allDownloadsComplete authorize downloadComplete downloadError downloadProgress downloadStart error exportComplete exportPage exportProgress exportStart kickOffEnd kickOffStart manifestComplete
    exportError: (
        this: BulkDataClient,
        details: {
            body: string | OperationOutcome | null;
            code: number | null;
            message?: string;
            responseHeaders?: ResponseHeaders;
        },
    ) => void
    abort: (this: BulkDataClient) => void

    Emitted when the flow is aborted by the user

    allDownloadsComplete: (
        this: BulkDataClient,
        downloads: Types.BulkDataClient.FileDownload[],
    ) => void

    Emitted when all files have been downloaded

    authorize: (this: BulkDataClient, accessToken: string) => void

    Emitted every time new access token is received

    downloadComplete: (
        this: BulkDataClient,
        detail: { fileSize: number; fileUrl: string; resourceCount: number | null },
    ) => void

    Emitted when any file has been downloaded

    downloadError: (
        this: BulkDataClient,
        details: {
            body: string | OperationOutcome | null;
            code: number | null;
            fileUrl: string;
            message?: string;
            responseHeaders?: ResponseHeaders;
        },
    ) => void

    Emitted for every file which fails to download

    downloadProgress: (
        this: BulkDataClient,
        downloads: Types.BulkDataClient.FileDownload[],
    ) => void

    Emitted for any status change while files are being downloaded

    downloadStart: (
        this: BulkDataClient,
        detail: { fileUrl: string; itemType: string; resourceType: string | null },
    ) => void

    Emitted when the download starts

    error: (this: BulkDataClient, error: Error) => void

    Emitted on error

    exportComplete: (this: BulkDataClient, manifest: ExportManifest) => void

    Emitted when the export is completed

    exportPage: (this: BulkDataClient, page: ExportManifest, url: string) => void

    Emitted when the export is completed

    exportProgress: (this: BulkDataClient, status: ExportStatus) => void

    Emitted for every status change while waiting for the export

    exportStart: (this: BulkDataClient, status: ExportStatus) => void

    Emitted when the export has began

    kickOffEnd: (
        this: BulkDataClient,
        data: {
            capabilityStatement: CapabilityStatement;
            requestParameters: Record<string, any>;
            response: Response;
            responseHeaders?: ResponseHeaders;
        },
    ) => void

    Emitted when a kick-off response is received

    kickOffStart: (
        this: BulkDataClient,
        requestOptions: OptionsOfUnknownResponseBody,
    ) => void

    Emitted when new export is started

    manifestComplete: (this: BulkDataClient, transactionTime: string) => void

    Emitted when all manifest pages are downloaded

    Settings
    Member Visibility

    On This Page
    Properties
    Events