mapbox-plugin-offline

//mapboxpluginoffline/io.github.xit0c.mapboxpluginoffline.model/NotificationOptions

NotificationOptions

[androidJvm]
class NotificationOptions@JvmOverloadsconstructor(@DrawableRessmallIconRes: Int, contentTitle: String, downloadContentText: String, cancelContentText: String, cancelActionText: String, requestMapSnapshot: Boolean, returnActivity: Class<*>?) : Parcelable

This model represents the options for the notification shown by the OfflineService.

Constructors

   
NotificationOptions [androidJvm]
@JvmOverloads
fun NotificationOptions(@DrawableRessmallIconRes: Int = android.R.drawable.stat_sys_download, contentTitle: String = “Offline Map”, downloadContentText: String = “Downloading…”, cancelContentText: String = “Deleting…”, cancelActionText: String = “Cancel”, requestMapSnapshot: Boolean = true, returnActivity: Class<*>? = null)
Creates a NotificationOptions with the given values.

Types

Name Summary
Companion [androidJvm]
object Companion

Functions

Name Summary
toString [androidJvm]
open override fun toString(): String
Returns a String representation of this object.

Properties

Name Summary
cancelActionText [androidJvm]
val cancelActionText: String
notification action text for download cancellation.
cancelContentText [androidJvm]
val cancelContentText: String
notification content text shown during cancellation.
contentTitle [androidJvm]
val contentTitle: String
notification content title.
downloadContentText [androidJvm]
val downloadContentText: String
notification content text shown during download.
requestMapSnapshot [androidJvm]
val requestMapSnapshot: Boolean = true
Whether or not to add a map snapshot of the region as the notification large icon.
returnActivity [androidJvm]
val returnActivity: Class<*>? = null
The activity to start on notification tap.
smallIconRes [androidJvm]
val smallIconRes: Int
DrawableRes id of the notification small icon.