Interface BulkDataClientEvents

The BulkDataClient instances emit the following events:

Hierarchy

BulkDataClientEvents

Index

Events

Methods

exportError

Events

abort

abort(this: BulkDataClient): void

- Defined in src/lib/BulkDataClient.ts:138
Emitted when the flow is aborted by the user

Parameters
- this: BulkDataClient
Returns void

allDownloadsComplete

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

- Defined in src/lib/BulkDataClient.ts:126
Emitted when all files have been downloaded

Parameters
- this: BulkDataClient
- downloads: Types.BulkDataClient.FileDownload[]
Returns void

authorize

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

- Defined in src/lib/BulkDataClient.ts:43
Emitted every time new access token is received

Parameters
- this: BulkDataClient
- accessToken: string
Returns void

downloadComplete

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

- Defined in src/lib/BulkDataClient.ts:116
Emitted when any file has been downloaded

Parameters
- this: BulkDataClient
- detail: { fileSize: number; fileUrl: string; resourceCount: null | number }
  - fileSize: number
  - fileUrl: string
  - resourceCount: null | number
Returns void

downloadError

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

- Defined in src/lib/BulkDataClient.ts:105
Emitted for every file which fails to download

Parameters
- this: BulkDataClient
- details: { body: null | string | OperationOutcome; code: null | number; fileUrl: string; message?: string }
  - body: null | string | OperationOutcome
  - code: null | number
  - fileUrl: string
  - Optional message?: string
Returns void

downloadProgress

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

- Defined in src/lib/BulkDataClient.ts:99
Emitted for any status change while files are being downloaded

Parameters
- this: BulkDataClient
- downloads: Types.BulkDataClient.FileDownload[]
Returns void

downloadStart

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

- Defined in src/lib/BulkDataClient.ts:89
Emitted when the download starts

Parameters
- this: BulkDataClient
- detail: { fileUrl: string; itemType: string; resourceType: null | string }
  - fileUrl: string
  - itemType: string
  - resourceType: null | string
Returns void

error

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

- Defined in src/lib/BulkDataClient.ts:132
Emitted on error

Parameters
- this: BulkDataClient
- error: Error
Returns void

exportComplete

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

- Defined in src/lib/BulkDataClient.ts:83
Emitted when the export is completed

Parameters
- this: BulkDataClient
- manifest: ExportManifest
Returns void

exportProgress

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

- Defined in src/lib/BulkDataClient.ts:71
Emitted for every status change while waiting for the export

Parameters
- this: BulkDataClient
- status: ExportStatus
Returns void

exportStart

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

- Defined in src/lib/BulkDataClient.ts:65
Emitted when the export has began

Parameters
- this: BulkDataClient
- status: ExportStatus
Returns void

kickOffEnd

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

- Defined in src/lib/BulkDataClient.ts:55
Emitted when a kick-off response is received

Parameters
- this: BulkDataClient
- data: { capabilityStatement: CapabilityStatement; requestParameters: Record<string, any>; response: Response<unknown> }
  - capabilityStatement: CapabilityStatement
  - requestParameters: Record<string, any>
  - response: Response<unknown>
Returns void

kickOffStart

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

- Defined in src/lib/BulkDataClient.ts:49
Emitted when new export is started

Parameters
- this: BulkDataClient
- requestOptions: OptionsOfUnknownResponseBody
Returns void

Methods

exportError

exportError(this: BulkDataClient, details: { body: null | string | OperationOutcome; code: null | number; message?: string }): void

- Defined in src/lib/BulkDataClient.ts:73
Parameters
- this: BulkDataClient
- details: { body: null | string | OperationOutcome; code: null | number; message?: string }
  - body: null | string | OperationOutcome
  - code: null | number
  - Optional message?: string
Returns void

Generated using TypeDoc