ReactAndroid/com.facebook.react.jstasks/HeadlessJsTaskConfig

HeadlessJsTaskConfig

class HeadlessJsTaskConfig @JvmOverloads constructor(val taskKey: String, val data: WritableMap, val timeout: Long = 0, val isAllowedInForeground: Boolean = false, val retryPolicy: HeadlessJsTaskRetryPolicy? = NoRetryPolicy.INSTANCE)

Class that holds the various parameters needed to start a JS task.

Constructors

constructor(source: HeadlessJsTaskConfig)

Copy constructor to create a HeadlessJsTaskConfig from an existing one. Equivalent to calling HeadlessJsTaskConfig with false for allowedInBackground.

@JvmOverloads

constructor(taskKey: String, data: WritableMap, timeout: Long = 0, isAllowedInForeground: Boolean = false, retryPolicy: HeadlessJsTaskRetryPolicy? = NoRetryPolicy.INSTANCE)

Properties

data

val data: WritableMap

a map of parameters passed to the JS task executor.

isAllowedInForeground

val isAllowedInForeground: Boolean = false

retryPolicy

val retryPolicy: HeadlessJsTaskRetryPolicy?

the number of times & delays the task should be retried on error.

taskKey

val taskKey: String

the key for the JS task to execute. This is the same key that you call AppRegistry.registerTask with in JS.

timeout

val timeout: Long = 0

the amount of time (in ms) after which the React instance should be terminated regardless of whether the task has completed or not. This is meant as a safeguard against accidentally keeping the device awake for long periods of time because JS crashed or some request timed out. A value of 0 means no timeout (should only be used for long-running tasks such as music playback).