Skip to content

Commit

Permalink
Merge pull request #11 from Unity-Technologies/devel
Browse files Browse the repository at this point in the history
Fix race condition on Android and make it a package
  • Loading branch information
aurimasc committed Nov 29, 2019
2 parents 6b11fc5 + 7a32495 commit de98fe8
Show file tree
Hide file tree
Showing 59 changed files with 804 additions and 197 deletions.
17 changes: 0 additions & 17 deletions BackgroundDownload/BackgroundDownload.asmdef

This file was deleted.

155 changes: 0 additions & 155 deletions BackgroundDownload/BackgroundDownload.cs

This file was deleted.

11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Changelog
All notable changes to this package will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2019-11-20

### This is the first release of *Unity Package com.unity.networking.backgrounddownload*.

*First release based on former plugin collection.*
7 changes: 7 additions & 0 deletions CHANGELOG.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contributing

## If you are interested in contributing, here are some ground rules:
* Clone https://github.com/Unity-Technologies/BackgroundDownload
* Ensure feature parity between all supported platforms

## All contributions are subject to the [Unity Contribution Agreement(UCA)](https://unity3d.com/legal/licenses/Unity_Contribution_Agreement)
By making a pull request, you are confirming agreement to the terms and conditions of the UCA, including that your Contributions are your original creation and that you have complete right and authority to make your Contributions.

## Once you have a change ready following these ground rules. Simply make a pull request
7 changes: 7 additions & 0 deletions CONTRIBUTING.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 40 additions & 0 deletions Documentation~/com.unity.backgrounddownload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# About <com.unity.backgrounddownload>

Use the <Background Download> package to <download large files in the background on mobile platforms>. The intent of this package is to let you fetch files that aren't required immediately with caring less about application lifecycle. The download will continue if your application goes into background and even if Operating System decides to close your application (usually due to low memory for foreground tasks).

The <Background Download> package however <is not a replacement for HTTP clients>. It has a specific focus on fetching files in lower priority for future use. Downloads may also be slower, since it is assumed that these download are of lower priority.


## Preview package
This package is available as a preview, so it is not ready for production use. The features and documentation in this package might change before it is verified for release.


## Package contents

The following table describes the package folder structure:

|**Location**|**Description**|
|---|---|
|*Runtime*|Contains <C# code and native plugins for mobile platforms>.|
|*Samples*|Contains <example C# scripts explaining how to use this package>.|

<a name="Installation"></a>

## Installation

To install this package, follow the instructions in the [Package Manager documentation](https://docs.unity3d.com/Manual/upm-ui-install.html).


## Requirements

This version of &lt;package name&gt; is compatible with the following versions of the Unity Editor:

* 2020.1 and later


## Known limitations

&lt;Background Download&gt; version &lt;0.1.0&gt; includes the following known limitations:

* &lt;Does not work in Editor, only compiles.&gt;
* &lt;Only Android, iOS and Universal Windows Platform are supported.&gt;
17 changes: 17 additions & 0 deletions Documentation~/filter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiRules:
- exclude:
# inherited Object methods
uidRegex: ^System\.Object\..*$
type: Method
- exclude:
# mentioning types from System.* namespace
uidRegex: ^System\..*$
type: Type
- exclude:
hasAttribute:
uid: System.ObsoleteAttribute
type: Member
- exclude:
hasAttribute:
uid: System.ObsoleteAttribute
type: Type
5 changes: 5 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
com.unity.networking.backgrounddownload copyright © 2019 Unity Technologies ApS

Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License).

Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.
7 changes: 7 additions & 0 deletions LICENSE.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions README.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Runtime.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit de98fe8

Please sign in to comment.