Coder Social home page Coder Social logo

msdgwzhy6 / react-native-simple-download-manager Goto Github PK

View Code? Open in Web Editor NEW

This project forked from a7ul/react-native-simple-download-manager

1.0 2.0 0.0 100 KB

A react native module to schedule downloads on native download manager

Home Page: https://www.npmjs.com/package/react-native-simple-download-manager

License: MIT License

Java 86.99% JavaScript 13.01%

react-native-simple-download-manager's Introduction

react-native-simple-download-manager

A simple straightforward react native module that lets you schedule downloads onto your download manager for android.

  • Support custom headers for authentication
  • File download scheduler
  • Cancel file downlaod
  • Check status of the download

TODO - ios module

Installation:

yarn add react-native-simple-download-manager

or

npm i react-native-simple-download-manager --save

Mostly automatic installation

react-native link react-native-simple-download-manager

Manual installation

Android

  1. Open up android/app/src/main/java/[...]/MainApplication.java
  • Add import com.masteratul.downloadmanager.ReactNativeDownloadManagerPackage; to the imports at the top of the file
  • Add new ReactNativeDownloadManagerPackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-simple-download-manager'
    project(':react-native-simple-download-manager').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-simple-download-manager/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      compile project(':react-native-simple-download-manager')
    

Usage

const downloadManager = require("react-native-simple-download-manager");

const url = "http://url/to/file.ext?query=parmas";
const headers = { Authorization: "Bearer abcsdsjkdjskjdkskjd" };
const config = {
  downloadTitle: "Title that should appear in Native Download manager",
  downloadDescription:
    "Description that should appear in Native Download manager",
  saveAsName: "File name to save",
  allowedInRoaming: true,
  allowedInMetered: true,
  showInDownloads: true,
  external: false, //when false basically means use the default Download path (version ^1.3)
  path: "Download/" //if "external" is true then use this path (version ^1.3)
};

downloadManager
  .download((url = ""), (headers = {}), (config = {}))
  .then(response => {
    console.log("Download success!");
  })
  .catch(err => {
    console.log("Download failed!");
  });

Advanced Usage

The module currently supports

  • download,
  • queueDownload,
  • attachOnCompleteListener,
  • cancel,
  • checkStatus

You can check https://github.com/master-atul/react-native-simple-download-manager/blob/master/index.js

Contributors

Peace ! โœŒ๐Ÿป๐ŸŒฎ

react-native-simple-download-manager's People

Contributors

a7ul avatar ibrahimtelman avatar kingdark1234 avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.