Capacitor plugin for downloading files to native device and document scanning
npm install taleemabad-capacitor-pluginCapacitor plugin for downloading files to native device and document scanning
``bash`
npm install taleemabad-capacitor-plugin
npx cap sync
* addListener(string, ...)
* Interfaces
`typescript`
startScan(options?: { pageLimit?: number; mode?: string; enableGalleryImport?: boolean; outputFormats?: OutputFormats; } | undefined) => Promise
| Param | Type |
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| options | { pageLimit?: number; mode?: string; enableGalleryImport?: boolean; outputFormats?: OutputFormats; } |
Returns: Promise<ScanResult>
---
`typescript`
startDownload(options: { url: string[]; }) => Promise<{ value: string[]; }>
| Param | Type |
| ------------- | ------------------------------- |
| options | { url: string[]; } |
Returns: Promise<{ value: string[]; }>
---
`typescript`
removeDownloads(options: { value: string[]; }) => Promise<{ value: string[]; }>
| Param | Type |
| ------------- | --------------------------------- |
| options | { value: string[]; } |
Returns: Promise<{ value: string[]; }>
---
`typescript`
resumeDownloads() => Promise<{ value: string; }>
Resumes all paused downloads. Returns a promise that resolves with a string indicating the result of the resume operation.
---
`typescript`
getDownloadList() => Promise<{ value: string; }>
Retrieves the list of all current downloads. Returns a promise that resolves with a string representing the list of current downloads.
---
`typescript`
addListener(eventName: String, listenerFunc: (download: { result: string; }) => void) => PluginListenerHandle
| Param | Type |
| ------------------ | ------------------------------------------------------- |
| eventName | String |
| listenerFunc | (download: { result: string; }) => void |
Returns: PluginListenerHandle
---
#### PluginListenerHandle
This interface represents the different types of download events.
| Prop | Type | Description | Android | iOS |
| ---------------------------- | ------------------- | -------------------------------------------- | ------- | --- |
| onAdded | String | Event when a download is added | YES | NO |
| onCancelled | String | Event when a download is cancelled | YES | NO |
| onCompleted | String | Event when a download is completed | YES | YES |
| onDeleted | String | Event when a download is deleted | YES | NO |
| onDownloadBlockUpdated | String | Event when a download block is updated | YES | NO |
| onError | String | Event when an error occurs during download | YES | YES |
| onPaused | String | Event when a download is paused | YES | NO |
| onProgress | String | Event when a download makes progress | YES | YES |
| onQueued | String | Event when a download is queued | YES | NO |
| onRemoved | String | Event when a download is removed | YES | NO |
| onResumed | String | Event when a download is resumed | YES | NO |
| onStarted | String | Event when a download is started | YES | NO |
| onWaitingNetwork | String | Event when a download is waiting for network | YES | NO |
| ScanResult |
| URLRequest |
| OutputFormats` |