public interface

ForegroundProcessor

 androidx.work.impl.foreground.ForegroundProcessor

Subclasses:

Processor

Gradle dependencies

compile group: 'androidx.work', name: 'work-runtime', version: '2.10.0-alpha03'

  • groupId: androidx.work
  • artifactId: work-runtime
  • version: 2.10.0-alpha03

Artifact androidx.work:work-runtime:2.10.0-alpha03 it located at Google repository (https://maven.google.com/)

Overview

An interface that provides WorkerWrapper the hooks to move a ListenableWorkers execution to the foreground.

Summary

Methods
public voidstartForeground(java.lang.String workSpecId, ForegroundInfo foregroundInfo)

Makes the foreground service aware of the WorkSpec id.

Methods

public void startForeground(java.lang.String workSpecId, ForegroundInfo foregroundInfo)

Makes the foreground service aware of the WorkSpec id.

Parameters:

workSpecId: The WorkSpec id
foregroundInfo: The ForegroundInfo associated

Source

/*
 * Copyright 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.work.impl.foreground;

import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import androidx.work.ForegroundInfo;

/**
 * An interface that provides {@link androidx.work.impl.WorkerWrapper} the hooks to move a
 * {@link androidx.work.ListenableWorker}s execution to the foreground.
 *
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public interface ForegroundProcessor {
    /**
     * Makes the foreground service aware of the {@link androidx.work.impl.model.WorkSpec} id.
     *
     * @param workSpecId     The {@link androidx.work.impl.model.WorkSpec} id
     * @param foregroundInfo The {@link ForegroundInfo} associated
     */
    void startForeground(@NonNull String workSpecId, @NonNull ForegroundInfo foregroundInfo);
}