registerOneOffTask method

Future<void> registerOneOffTask(String uniqueName, String taskName, { String? tag, ExistingWorkPolicy? existingWorkPolicy, Duration initialDelay = Duration.zero, Constraints? constraints, BackoffPolicy? backoffPolicy, Duration backoffPolicyDelay = Duration.zero, OutOfQuotaPolicy? outOfQuotaPolicy, Map<String, dynamic>? inputData, })

Schedule a one off task A uniqueName is required so only one task can be registered. The taskName is the value that will be returned in the BackgroundTaskHandler The inputData is the input data for task. Valid value types are: int, bool, double, String and their list

Implementation

Future<void> registerOneOffTask(
  /// Only supported on Android.
  final String uniqueName,

  /// Only supported on Android.
  final String taskName, {

  /// Only supported on Android.
  final String? tag,

  /// Only supported on Android.
  final ExistingWorkPolicy? existingWorkPolicy,

  /// Configures a initial delay.
  ///
  /// The delay configured here is not guaranteed. The underlying system may
  /// decide to schedule the ask a lot later.
  final Duration initialDelay = Duration.zero,

  /// Fully supported on Android, but only partially supported on iOS.
  /// See [Constraints] for details.
  final Constraints? constraints,
  final BackoffPolicy? backoffPolicy,
  final Duration backoffPolicyDelay = Duration.zero,
  final OutOfQuotaPolicy? outOfQuotaPolicy,
  final Map<String, dynamic>? inputData,
}) async =>
    await _foregroundChannel.invokeMethod(
      "registerOneOffTask",
      JsonMapperHelper.toRegisterMethodArgument(
        isInDebugMode: _isInDebugMode,
        uniqueName: uniqueName,
        taskName: taskName,
        tag: tag,
        existingWorkPolicy: existingWorkPolicy,
        initialDelay: initialDelay,
        constraints: constraints,
        backoffPolicy: backoffPolicy,
        backoffPolicyDelay: backoffPolicyDelay,
        outOfQuotaPolicy: outOfQuotaPolicy,
        inputData: inputData,
      ),
    );