VdoDownloadManager

java.lang.Object
- com.vdocipher.aegis.offline.VdoDownloadManager

```
public class VdoDownloadManager
extends java.lang.Object
```
VdoDownloadManager handles enqueuing download requests and management of media downloads.
New download requests can be added which will remain in queue and downloaded serially.
Status of media downloads can be requested using filtered queries.
Download events can be listened to by registering a listener with the VdoDownloadManager instance. Make sure to unregister listener when not required to avoid memory leaks.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`VdoDownloadManager.EventListener` Callback interface for listening to download events.
`static class`	`VdoDownloadManager.Query` Class used to specify filters for a query.
`static interface`	`VdoDownloadManager.QueryResultListener` Callback interface for listening to query results.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERROR_CANNOT_RESUME`
`static int`	`ERROR_DATABASE`
`static int`	`ERROR_DEVICE_NOT_FOUND`
`static int`	`ERROR_DOWNLOAD_MANAGER`
`static int`	`ERROR_DRM`
`static int`	`ERROR_FILE_ALREADY_EXISTS`
`static int`	`ERROR_FILE_ERROR`
`static int`	`ERROR_FILE_PERMISSION_DENIED`
`static int`	`ERROR_HTTP_DATA_ERROR`
`static int`	`ERROR_INSUFFICIENT_SPACE`
`static int`	`ERROR_INVALID_DOWNLOAD_SPEC`
`static int`	`ERROR_LICENSE`
`static int`	`ERROR_SERVER_DENIED`
`static int`	`ERROR_SERVER_ERROR`
`static int`	`ERROR_TOO_MANY_REDIRECTS`
`static int`	`ERROR_UNHANDLED_HTTP_CODE`
`static int`	`ERROR_UNKNOWN`
`static int`	`PAUSED_EXPLICIT`
`static int`	`PAUSED_QUEUED_FOR_WIFI`
`static int`	`PAUSED_UNKNOWN`
`static int`	`PAUSED_WAITING_FOR_NETWORK`
`static int`	`PAUSED_WAITING_TO_RETRY`
`static int`	`STATUS_COMPLETED`
`static int`	`STATUS_DOWNLOADING`
`static int`	`STATUS_FAILED`
`static int`	`STATUS_NOT_FOUND`
`static int`	`STATUS_PAUSED`
`static int`	`STATUS_PENDING`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEventListener(VdoDownloadManager.EventListener listener)` Add a listener for download events.
`void`	`enqueue(DownloadRequest request)` Enqueue a request to be downloaded.
`static VdoDownloadManager`	`getInstance(Context context)` Get an instance of `VdoDownloadManager`.
`void`	`query(VdoDownloadManager.Query query, VdoDownloadManager.QueryResultListener queryResultListener)` Query the VdoDownloadManager about media downloads that have been requested.
`void`	`remove(java.lang.String... mediaIds)` Cancel media downloads and delete them locally.
`void`	`removeEventListener(VdoDownloadManager.EventListener listener)` Remove a listener of download events.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STATUS_NOT_FOUND
```
public static final int STATUS_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - STATUS_PENDING
```
public static final int STATUS_PENDING
```
    See Also:
    
    Constant Field Values
  - STATUS_DOWNLOADING
```
public static final int STATUS_DOWNLOADING
```
    See Also:
    
    Constant Field Values
  - STATUS_PAUSED
```
public static final int STATUS_PAUSED
```
    See Also:
    
    Constant Field Values
  - STATUS_COMPLETED
```
public static final int STATUS_COMPLETED
```
    See Also:
    
    Constant Field Values
  - STATUS_FAILED
```
public static final int STATUS_FAILED
```
    See Also:
    
    Constant Field Values
  - PAUSED_EXPLICIT
```
public static final int PAUSED_EXPLICIT
```
    See Also:
    
    Constant Field Values
  - PAUSED_QUEUED_FOR_WIFI
```
public static final int PAUSED_QUEUED_FOR_WIFI
```
    See Also:
    
    Constant Field Values
  - PAUSED_UNKNOWN
```
public static final int PAUSED_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - PAUSED_WAITING_FOR_NETWORK
```
public static final int PAUSED_WAITING_FOR_NETWORK
```
    See Also:
    
    Constant Field Values
  - PAUSED_WAITING_TO_RETRY
```
public static final int PAUSED_WAITING_TO_RETRY
```
    See Also:
    
    Constant Field Values
  - ERROR_UNKNOWN
```
public static final int ERROR_UNKNOWN
```
    See Also:
    
    Constant Field Values
  - ERROR_CANNOT_RESUME
```
public static final int ERROR_CANNOT_RESUME
```
    See Also:
    
    Constant Field Values
  - ERROR_INVALID_DOWNLOAD_SPEC
```
public static final int ERROR_INVALID_DOWNLOAD_SPEC
```
    See Also:
    
    Constant Field Values
  - ERROR_DOWNLOAD_MANAGER
```
public static final int ERROR_DOWNLOAD_MANAGER
```
    See Also:
    
    Constant Field Values
  - ERROR_UNHANDLED_HTTP_CODE
```
public static final int ERROR_UNHANDLED_HTTP_CODE
```
    See Also:
    
    Constant Field Values
  - ERROR_SERVER_DENIED
```
public static final int ERROR_SERVER_DENIED
```
    See Also:
    
    Constant Field Values
  - ERROR_SERVER_ERROR
```
public static final int ERROR_SERVER_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_HTTP_DATA_ERROR
```
public static final int ERROR_HTTP_DATA_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_TOO_MANY_REDIRECTS
```
public static final int ERROR_TOO_MANY_REDIRECTS
```
    See Also:
    
    Constant Field Values
  - ERROR_FILE_ERROR
```
public static final int ERROR_FILE_ERROR
```
    See Also:
    
    Constant Field Values
  - ERROR_DEVICE_NOT_FOUND
```
public static final int ERROR_DEVICE_NOT_FOUND
```
    See Also:
    
    Constant Field Values
  - ERROR_FILE_ALREADY_EXISTS
```
public static final int ERROR_FILE_ALREADY_EXISTS
```
    See Also:
    
    Constant Field Values
  - ERROR_INSUFFICIENT_SPACE
```
public static final int ERROR_INSUFFICIENT_SPACE
```
    See Also:
    
    Constant Field Values
  - ERROR_FILE_PERMISSION_DENIED
```
public static final int ERROR_FILE_PERMISSION_DENIED
```
    See Also:
    
    Constant Field Values
  - ERROR_DATABASE
```
public static final int ERROR_DATABASE
```
    See Also:
    
    Constant Field Values
  - ERROR_LICENSE
```
public static final int ERROR_LICENSE
```
    See Also:
    
    Constant Field Values
  - ERROR_DRM
```
public static final int ERROR_DRM
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getInstance
```
public static VdoDownloadManager getInstance(Context context)
```
    Get an instance of VdoDownloadManager.
    
    Parameters:
    
    context - a Context
    
    Returns:
    
    VdoDownloadManager instance
    
    Throws:
    
    java.lang.RuntimeException - if Build.VERSION#SDK_INT is lower than 21 (Lollipop)
  - addEventListener
```
public void addEventListener(VdoDownloadManager.EventListener listener)
```
    Add a listener for download events.
  - removeEventListener
```
public void removeEventListener(VdoDownloadManager.EventListener listener)
```
    Remove a listener of download events.
  - enqueue
```
public void enqueue(DownloadRequest request)
```
    Enqueue a request to be downloaded.
    
    Parameters:
    
    request - a download request
    
    Throws:
    
    java.lang.IllegalArgumentException - if the provided download path is not an existing directory on external storage or if the request is invalid
    
    java.lang.IllegalStateException - if the external storage is not mounted in read and write mode
  - query
```
public void query(VdoDownloadManager.Query query,
                  VdoDownloadManager.QueryResultListener queryResultListener)
```
    Query the VdoDownloadManager about media downloads that have been requested. The results are provided asynchronously to the provided VdoDownloadManager.QueryResultListener.
    
    Parameters:
    
    query - a query specifying filters
    
    queryResultListener - a listener for the query results
  - remove
```
public void remove(java.lang.String... mediaIds)
```
    Cancel media downloads and delete them locally.
    
    Parameters:
    
    mediaIds - mediaIds for media to be removed

Class VdoDownloadManager

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_NOT_FOUND

STATUS_PENDING

STATUS_DOWNLOADING

STATUS_PAUSED

STATUS_COMPLETED

STATUS_FAILED

PAUSED_EXPLICIT

PAUSED_QUEUED_FOR_WIFI

PAUSED_UNKNOWN

PAUSED_WAITING_FOR_NETWORK

PAUSED_WAITING_TO_RETRY

ERROR_UNKNOWN

ERROR_CANNOT_RESUME

ERROR_INVALID_DOWNLOAD_SPEC

ERROR_DOWNLOAD_MANAGER

ERROR_UNHANDLED_HTTP_CODE

ERROR_SERVER_DENIED

ERROR_SERVER_ERROR

ERROR_HTTP_DATA_ERROR

ERROR_TOO_MANY_REDIRECTS

ERROR_FILE_ERROR

ERROR_DEVICE_NOT_FOUND

ERROR_FILE_ALREADY_EXISTS

ERROR_INSUFFICIENT_SPACE

ERROR_FILE_PERMISSION_DENIED

ERROR_DATABASE

ERROR_LICENSE

ERROR_DRM

Method Detail

getInstance

addEventListener

removeEventListener

enqueue

query

remove