Database Download Progress

🔄 Event: `onDatabaseDownloadProgress`

📌 Overview

onDatabaseDownloadProgress is an event callback triggered by the REL-ID IDV SDK to provide real-time progress updates while a database is being downloaded to the devi

🔁 Triggered By

Automatically invoked when setIDVDatabaseID() is called and the database file needs to be downloaded.

📥 Parameters (JSON Payload)

{
  "downloadProgress": 0,
  "databaseID": "India"
}

Field	Type	Description
`downloadProgress`	int	Progress status (see `RDNAIDVDownloadStatus` enum)
`databaseID`	string	ID of the database currently being downloaded

RDNAIDVDownloadStatus Enum Values

Value	Status
0	Download Started
1	In Progress
2	Completed
3	Failed

💻 Platform-Specific Listener Setup

React Native

EventEmitter.addListener('onDatabaseDownloadProgress', (response) => {
  console.log('Progress:', response.downloadProgress);
  console.log('Database:', response.databaseID);
});

Flutter

rdna.on('onDatabaseDownloadProgress', (response) {
  print("Progress: ${response['downloadProgress']}, Database: ${response['databaseID']}");
});

Cordova

document.addEventListener('onDatabaseDownloadProgress', function(response) {
  console.log("Progress:", response.downloadProgress);
  console.log("Database ID:", response.databaseID);
});

Native Android

@Override
public void onDatabaseDownloadProgress(RDNAIDVDownloadStatus status, String databaseID) {
  Log.d("DBDownload", "Progress: " + status + ", DB: " + databaseID);
}

Native iOS

- (void)onDatabaseDownloadProgress:(RDNAIDVDownloadStatus)status databaseID:(NSString *)databaseID {
  NSLog(@"Progress: %ld, Database ID: %@", (long)status, databaseID);
}

📚 RDNAIDVDownloadStatus Enum Details

Enum Constant	Value	Description
`RDNA_IDV_STARTED`	0	Database download started
`RDNA_IDV_INPROGRESS`	1	Database download is in progress
`RDNA_IDV_COMPLETED`	2	Database download completed
`RDNA_IDV_FAILED`	3	Database download failed

These values can be used to interpret the downloadProgress field in the onDatabaseDownloadProgress event.

Updated about 2 months ago

🔄 Event: onDatabaseDownloadProgress