Skip to content

Commit 2ea30d7

Browse files
committed
OfflineDownload.getPercentage static method moved to OfflineUtils.getCompletionPercentage; added OfflineRegionStatus.getCompletionPercentage extension function; minor docs fixes
1 parent bd05361 commit 2ea30d7

File tree

42 files changed

+117
-80
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+117
-80
lines changed

.idea/misc.xml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ An alternative to [Mapbox offline plugin](https://github.com/mapbox/mapbox-plugi
55

66
This plugin is published to [Bintray's JCenter](https://bintray.com/bintray/jcenter). Include it in your `build.gradle` file with
77
```gradle
8-
implementation 'dev.micheleferretti:mapbox-plugin-offline:2.1.0'
8+
implementation 'dev.micheleferretti:mapbox-plugin-offline:2.2.0'
99
```
1010

1111
## Usage

docs/alltypes/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ events and monitor active downloads.
5151
##### [com.mapbox.mapboxsdk.offline.OfflineRegionDefinition](../dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-definition/index.md)
5252

5353

54+
| (extensions in package dev.micheleferretti.mapboxpluginoffline.utils)
55+
56+
##### [com.mapbox.mapboxsdk.offline.OfflineRegionStatus](../dev.micheleferretti.mapboxpluginoffline.utils/com.mapbox.mapboxsdk.offline.-offline-region-status/index.md)
57+
58+
5459
|
5560

5661
##### [dev.micheleferretti.mapboxpluginoffline.OfflineService](../dev.micheleferretti.mapboxpluginoffline/-offline-service/index.md)

docs/dev.micheleferretti.mapboxpluginoffline.model/-notification-options/-e-x-t-r-a_-r-e-g-i-o-n_-i-d_-f-o-r_-a-c-t-i-v-i-t-y.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
# EXTRA_REGION_ID_FOR_ACTIVITY
44

5-
`const val EXTRA_REGION_ID_FOR_ACTIVITY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L36)
5+
`const val EXTRA_REGION_ID_FOR_ACTIVITY: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L37)
66

77
Key for the `OfflineRegion` id put as an extra of the Intent used to start [returnActivity](return-activity.md).
88

99
**See Also**
1010

11-
[dev.micheleferretti.mapboxpluginoffline.utils.OfflineUtils.getRegionIdFromIntent](../../dev.micheleferretti.mapboxpluginoffline.utils/-offline-utils/get-region-id-from-intent.md)
11+
[OfflineUtils.getRegionIdFromIntent](../../dev.micheleferretti.mapboxpluginoffline.utils/-offline-utils/get-region-id-from-intent.md)
1212

docs/dev.micheleferretti.mapboxpluginoffline.model/-notification-options/cancel-action-text.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# cancelActionText
44

5-
`val cancelActionText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L26)
5+
`val cancelActionText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L27)
66

77
notification action text for download cancellation.
88

docs/dev.micheleferretti.mapboxpluginoffline.model/-notification-options/cancel-content-text.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# cancelContentText
44

5-
`val cancelContentText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L25)
5+
`val cancelContentText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L26)
66

77
notification content text shown during cancellation.
88

docs/dev.micheleferretti.mapboxpluginoffline.model/-notification-options/content-title.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# contentTitle
44

5-
`val contentTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L23)
5+
`val contentTitle: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L24)
66

77
notification content title.
88

docs/dev.micheleferretti.mapboxpluginoffline.model/-notification-options/download-content-text.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# downloadContentText
44

5-
`val downloadContentText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L24)
5+
`val downloadContentText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L25)
66

77
notification content text shown during download.
88

docs/dev.micheleferretti.mapboxpluginoffline.model/-notification-options/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# NotificationOptions
44

5-
`class NotificationOptions : `[`Parcelable`](https://developer.android.com/reference/android/os/Parcelable.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L21)
5+
`class NotificationOptions : `[`Parcelable`](https://developer.android.com/reference/android/os/Parcelable.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L22)
66

77
This model represents the options for the notification shown by
88
the [OfflineService](../../dev.micheleferretti.mapboxpluginoffline/-offline-service/index.md).

docs/dev.micheleferretti.mapboxpluginoffline.model/-notification-options/request-map-snapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# requestMapSnapshot
44

5-
`val requestMapSnapshot: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L27)
5+
`val requestMapSnapshot: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) [(source)](https://github.com/xit0c/mapbox-plugin-offline/tree/master/mapboxpluginoffline/src/main/java/dev/micheleferretti/mapboxpluginoffline/model/NotificationOptions.kt#L28)
66

77
Whether or not to add a map snapshot of the region as the notification large icon.
88

0 commit comments

Comments
 (0)