blob: 0ecdec1756c5616891d93dd7b5d5c69e5b277e49 [file] [log] [blame]
Alan Viverettecd1aae02019-08-28 15:28:57 -04001// Signature format: 3.0
2package androidx.work {
3
4 public final class ArrayCreatingInputMerger extends androidx.work.InputMerger {
5 ctor public ArrayCreatingInputMerger();
6 method public androidx.work.Data merge(java.util.List<androidx.work.Data!>);
7 }
8
9 public enum BackoffPolicy {
10 enum_constant public static final androidx.work.BackoffPolicy EXPONENTIAL;
11 enum_constant public static final androidx.work.BackoffPolicy LINEAR;
12 }
13
14 public final class Configuration {
15 method public java.util.concurrent.Executor getExecutor();
16 method public androidx.work.InputMergerFactory getInputMergerFactory();
17 method public int getMaxJobSchedulerId();
18 method public int getMinJobSchedulerId();
19 method public java.util.concurrent.Executor getTaskExecutor();
20 method public androidx.work.WorkerFactory getWorkerFactory();
21 field public static final int MIN_SCHEDULER_LIMIT = 20; // 0x14
22 }
23
24 public static final class Configuration.Builder {
25 ctor public Configuration.Builder();
26 method public androidx.work.Configuration build();
27 method public androidx.work.Configuration.Builder setExecutor(java.util.concurrent.Executor);
28 method public androidx.work.Configuration.Builder setInputMergerFactory(androidx.work.InputMergerFactory);
29 method public androidx.work.Configuration.Builder setJobSchedulerJobIdRange(int, int);
30 method public androidx.work.Configuration.Builder setMaxSchedulerLimit(int);
31 method public androidx.work.Configuration.Builder setMinimumLoggingLevel(int);
32 method public androidx.work.Configuration.Builder setTaskExecutor(java.util.concurrent.Executor);
33 method public androidx.work.Configuration.Builder setWorkerFactory(androidx.work.WorkerFactory);
34 }
35
36 public static interface Configuration.Provider {
37 method public androidx.work.Configuration getWorkManagerConfiguration();
38 }
39
40 public final class Constraints {
41 ctor public Constraints(androidx.work.Constraints);
42 method public androidx.work.NetworkType getRequiredNetworkType();
43 method public boolean requiresBatteryNotLow();
44 method public boolean requiresCharging();
45 method @RequiresApi(23) public boolean requiresDeviceIdle();
46 method public boolean requiresStorageNotLow();
47 field public static final androidx.work.Constraints! NONE;
48 }
49
50 public static final class Constraints.Builder {
51 ctor public Constraints.Builder();
52 method @RequiresApi(24) public androidx.work.Constraints.Builder addContentUriTrigger(android.net.Uri, boolean);
53 method public androidx.work.Constraints build();
54 method public androidx.work.Constraints.Builder setRequiredNetworkType(androidx.work.NetworkType);
55 method public androidx.work.Constraints.Builder setRequiresBatteryNotLow(boolean);
56 method public androidx.work.Constraints.Builder setRequiresCharging(boolean);
57 method @RequiresApi(23) public androidx.work.Constraints.Builder setRequiresDeviceIdle(boolean);
58 method public androidx.work.Constraints.Builder setRequiresStorageNotLow(boolean);
59 method @RequiresApi(24) public androidx.work.Constraints.Builder setTriggerContentMaxDelay(long, java.util.concurrent.TimeUnit);
60 method @RequiresApi(26) public androidx.work.Constraints.Builder setTriggerContentMaxDelay(java.time.Duration!);
61 method @RequiresApi(24) public androidx.work.Constraints.Builder setTriggerContentUpdateDelay(long, java.util.concurrent.TimeUnit);
62 method @RequiresApi(26) public androidx.work.Constraints.Builder setTriggerContentUpdateDelay(java.time.Duration!);
63 }
64
65 public final class Data {
66 ctor public Data(androidx.work.Data);
Alan Viverettecd1aae02019-08-28 15:28:57 -040067 method public static androidx.work.Data fromByteArray(byte[]);
68 method public boolean getBoolean(String, boolean);
69 method public boolean[]? getBooleanArray(String);
70 method public byte getByte(String, byte);
71 method public byte[]? getByteArray(String);
72 method public double getDouble(String, double);
73 method public double[]? getDoubleArray(String);
74 method public float getFloat(String, float);
75 method public float[]? getFloatArray(String);
76 method public int getInt(String, int);
77 method public int[]? getIntArray(String);
78 method public java.util.Map<java.lang.String!,java.lang.Object!> getKeyValueMap();
79 method public long getLong(String, long);
80 method public long[]? getLongArray(String);
81 method public String? getString(String);
82 method public String![]? getStringArray(String);
Rahul Ravikumar3efec662019-10-01 10:13:26 -070083 method public <T> boolean hasKeyWithValueOfType(String, Class<T!>);
Alan Viverettecd1aae02019-08-28 15:28:57 -040084 method public byte[] toByteArray();
85 field public static final androidx.work.Data! EMPTY;
86 field public static final int MAX_DATA_BYTES = 10240; // 0x2800
87 }
88
89 public static final class Data.Builder {
90 ctor public Data.Builder();
91 method public androidx.work.Data build();
92 method public androidx.work.Data.Builder putAll(androidx.work.Data);
93 method public androidx.work.Data.Builder putAll(java.util.Map<java.lang.String!,java.lang.Object!>);
94 method public androidx.work.Data.Builder putBoolean(String, boolean);
95 method public androidx.work.Data.Builder putBooleanArray(String, boolean[]);
96 method public androidx.work.Data.Builder putByte(String, byte);
97 method public androidx.work.Data.Builder putByteArray(String, byte[]);
98 method public androidx.work.Data.Builder putDouble(String, double);
99 method public androidx.work.Data.Builder putDoubleArray(String, double[]);
100 method public androidx.work.Data.Builder putFloat(String, float);
101 method public androidx.work.Data.Builder putFloatArray(String, float[]);
102 method public androidx.work.Data.Builder putInt(String, int);
103 method public androidx.work.Data.Builder putIntArray(String, int[]);
104 method public androidx.work.Data.Builder putLong(String, long);
105 method public androidx.work.Data.Builder putLongArray(String, long[]);
106 method public androidx.work.Data.Builder putString(String, String?);
107 method public androidx.work.Data.Builder putStringArray(String, String![]);
108 }
109
110 public class DelegatingWorkerFactory extends androidx.work.WorkerFactory {
111 ctor public DelegatingWorkerFactory();
112 method public final void addFactory(androidx.work.WorkerFactory);
113 method public final androidx.work.ListenableWorker? createWorker(android.content.Context, String, androidx.work.WorkerParameters);
114 }
115
116 public enum ExistingPeriodicWorkPolicy {
117 enum_constant public static final androidx.work.ExistingPeriodicWorkPolicy KEEP;
118 enum_constant public static final androidx.work.ExistingPeriodicWorkPolicy REPLACE;
119 }
120
121 public enum ExistingWorkPolicy {
122 enum_constant public static final androidx.work.ExistingWorkPolicy APPEND;
123 enum_constant public static final androidx.work.ExistingWorkPolicy KEEP;
124 enum_constant public static final androidx.work.ExistingWorkPolicy REPLACE;
125 }
126
Rahul Ravikumar3ceb16d2019-10-03 17:20:59 -0700127 public final class ForegroundInfo {
Rahul Ravikumarb29c1de2019-12-04 12:20:34 -0800128 ctor public ForegroundInfo(int, android.app.Notification);
129 ctor public ForegroundInfo(int, android.app.Notification, int);
Rahul Ravikumar4111fbd2019-10-15 12:28:11 -0700130 method public int getForegroundServiceType();
Rahul Ravikumar3ceb16d2019-10-03 17:20:59 -0700131 method public android.app.Notification getNotification();
Rahul Ravikumarb29c1de2019-12-04 12:20:34 -0800132 method public int getNotificationId();
Rahul Ravikumar3ceb16d2019-10-03 17:20:59 -0700133 }
134
135 public interface ForegroundUpdater {
136 method public com.google.common.util.concurrent.ListenableFuture<java.lang.Void!> setForegroundAsync(android.content.Context, java.util.UUID, androidx.work.ForegroundInfo);
137 }
138
Alan Viverettecd1aae02019-08-28 15:28:57 -0400139 public abstract class InputMerger {
140 ctor public InputMerger();
141 method public abstract androidx.work.Data merge(java.util.List<androidx.work.Data!>);
142 }
143
144 public abstract class InputMergerFactory {
145 ctor public InputMergerFactory();
146 method public abstract androidx.work.InputMerger? createInputMerger(String);
147 }
148
149 public abstract class ListenableWorker {
150 ctor @Keep public ListenableWorker(android.content.Context, androidx.work.WorkerParameters);
151 method public final android.content.Context getApplicationContext();
152 method public final java.util.UUID getId();
153 method public final androidx.work.Data getInputData();
154 method @RequiresApi(28) public final android.net.Network? getNetwork();
155 method @IntRange(from=0) public final int getRunAttemptCount();
156 method public final java.util.Set<java.lang.String!> getTags();
157 method @RequiresApi(24) public final java.util.List<java.lang.String!> getTriggeredContentAuthorities();
158 method @RequiresApi(24) public final java.util.List<android.net.Uri!> getTriggeredContentUris();
159 method public final boolean isStopped();
160 method public void onStopped();
Rahul Ravikumar3ceb16d2019-10-03 17:20:59 -0700161 method public final com.google.common.util.concurrent.ListenableFuture<java.lang.Void!> setForegroundAsync(androidx.work.ForegroundInfo);
Alan Viverettecd1aae02019-08-28 15:28:57 -0400162 method public final com.google.common.util.concurrent.ListenableFuture<java.lang.Void!> setProgressAsync(androidx.work.Data);
163 method @MainThread public abstract com.google.common.util.concurrent.ListenableFuture<androidx.work.ListenableWorker.Result!> startWork();
164 }
165
166 public abstract static class ListenableWorker.Result {
167 method public static androidx.work.ListenableWorker.Result failure();
168 method public static androidx.work.ListenableWorker.Result failure(androidx.work.Data);
169 method public static androidx.work.ListenableWorker.Result retry();
170 method public static androidx.work.ListenableWorker.Result success();
171 method public static androidx.work.ListenableWorker.Result success(androidx.work.Data);
172 }
173
174 public enum NetworkType {
175 enum_constant public static final androidx.work.NetworkType CONNECTED;
176 enum_constant public static final androidx.work.NetworkType METERED;
177 enum_constant public static final androidx.work.NetworkType NOT_REQUIRED;
178 enum_constant public static final androidx.work.NetworkType NOT_ROAMING;
179 enum_constant public static final androidx.work.NetworkType UNMETERED;
180 }
181
182 public final class OneTimeWorkRequest extends androidx.work.WorkRequest {
183 method public static androidx.work.OneTimeWorkRequest from(Class<? extends androidx.work.ListenableWorker>);
184 method public static java.util.List<androidx.work.OneTimeWorkRequest!> from(java.util.List<java.lang.Class<? extends androidx.work.ListenableWorker>!>);
185 }
186
187 public static final class OneTimeWorkRequest.Builder extends androidx.work.WorkRequest.Builder<androidx.work.OneTimeWorkRequest.Builder,androidx.work.OneTimeWorkRequest> {
188 ctor public OneTimeWorkRequest.Builder(Class<? extends androidx.work.ListenableWorker>);
189 method public androidx.work.OneTimeWorkRequest.Builder setInputMerger(Class<? extends androidx.work.InputMerger>);
190 }
191
192 public interface Operation {
193 method public com.google.common.util.concurrent.ListenableFuture<androidx.work.Operation.State.SUCCESS!> getResult();
194 method public androidx.lifecycle.LiveData<androidx.work.Operation.State!> getState();
195 }
196
197 public abstract static class Operation.State {
198 }
199
200 public static final class Operation.State.FAILURE extends androidx.work.Operation.State {
201 ctor public Operation.State.FAILURE(Throwable);
202 method public Throwable getThrowable();
203 }
204
205 public static final class Operation.State.IN_PROGRESS extends androidx.work.Operation.State {
206 }
207
208 public static final class Operation.State.SUCCESS extends androidx.work.Operation.State {
209 }
210
211 public final class OverwritingInputMerger extends androidx.work.InputMerger {
212 ctor public OverwritingInputMerger();
213 method public androidx.work.Data merge(java.util.List<androidx.work.Data!>);
214 }
215
216 public final class PeriodicWorkRequest extends androidx.work.WorkRequest {
217 field public static final long MIN_PERIODIC_FLEX_MILLIS = 300000L; // 0x493e0L
218 field public static final long MIN_PERIODIC_INTERVAL_MILLIS = 900000L; // 0xdbba0L
219 }
220
221 public static final class PeriodicWorkRequest.Builder extends androidx.work.WorkRequest.Builder<androidx.work.PeriodicWorkRequest.Builder,androidx.work.PeriodicWorkRequest> {
222 ctor public PeriodicWorkRequest.Builder(Class<? extends androidx.work.ListenableWorker>, long, java.util.concurrent.TimeUnit);
223 ctor @RequiresApi(26) public PeriodicWorkRequest.Builder(Class<? extends androidx.work.ListenableWorker>, java.time.Duration);
224 ctor public PeriodicWorkRequest.Builder(Class<? extends androidx.work.ListenableWorker>, long, java.util.concurrent.TimeUnit, long, java.util.concurrent.TimeUnit);
225 ctor @RequiresApi(26) public PeriodicWorkRequest.Builder(Class<? extends androidx.work.ListenableWorker>, java.time.Duration, java.time.Duration);
226 }
227
228 public interface ProgressUpdater {
Rahul Ravikumar3ceb16d2019-10-03 17:20:59 -0700229 method public com.google.common.util.concurrent.ListenableFuture<java.lang.Void!> updateProgress(android.content.Context, java.util.UUID, androidx.work.Data);
Alan Viverettecd1aae02019-08-28 15:28:57 -0400230 }
231
232 public abstract class WorkContinuation {
233 ctor public WorkContinuation();
234 method public static androidx.work.WorkContinuation combine(java.util.List<androidx.work.WorkContinuation!>);
235 method public abstract androidx.work.Operation enqueue();
236 method public abstract com.google.common.util.concurrent.ListenableFuture<java.util.List<androidx.work.WorkInfo!>!> getWorkInfos();
237 method public abstract androidx.lifecycle.LiveData<java.util.List<androidx.work.WorkInfo!>!> getWorkInfosLiveData();
238 method public final androidx.work.WorkContinuation then(androidx.work.OneTimeWorkRequest);
239 method public abstract androidx.work.WorkContinuation then(java.util.List<androidx.work.OneTimeWorkRequest!>);
240 }
241
242 public final class WorkInfo {
243 method public java.util.UUID getId();
244 method public androidx.work.Data getOutputData();
245 method public androidx.work.Data getProgress();
246 method @IntRange(from=0) public int getRunAttemptCount();
247 method public androidx.work.WorkInfo.State getState();
248 method public java.util.Set<java.lang.String!> getTags();
249 }
250
251 public enum WorkInfo.State {
252 method public boolean isFinished();
253 enum_constant public static final androidx.work.WorkInfo.State BLOCKED;
254 enum_constant public static final androidx.work.WorkInfo.State CANCELLED;
255 enum_constant public static final androidx.work.WorkInfo.State ENQUEUED;
256 enum_constant public static final androidx.work.WorkInfo.State FAILED;
257 enum_constant public static final androidx.work.WorkInfo.State RUNNING;
258 enum_constant public static final androidx.work.WorkInfo.State SUCCEEDED;
259 }
260
261 public abstract class WorkManager {
262 method public final androidx.work.WorkContinuation beginUniqueWork(String, androidx.work.ExistingWorkPolicy, androidx.work.OneTimeWorkRequest);
263 method public abstract androidx.work.WorkContinuation beginUniqueWork(String, androidx.work.ExistingWorkPolicy, java.util.List<androidx.work.OneTimeWorkRequest!>);
264 method public final androidx.work.WorkContinuation beginWith(androidx.work.OneTimeWorkRequest);
265 method public abstract androidx.work.WorkContinuation beginWith(java.util.List<androidx.work.OneTimeWorkRequest!>);
266 method public abstract androidx.work.Operation cancelAllWork();
267 method public abstract androidx.work.Operation cancelAllWorkByTag(String);
268 method public abstract androidx.work.Operation cancelUniqueWork(String);
269 method public abstract androidx.work.Operation cancelWorkById(java.util.UUID);
Rahul Ravikumarbc0450b2019-10-15 16:17:46 -0700270 method public abstract android.app.PendingIntent createCancelPendingIntent(java.util.UUID);
Alan Viverettecd1aae02019-08-28 15:28:57 -0400271 method public final androidx.work.Operation enqueue(androidx.work.WorkRequest);
272 method public abstract androidx.work.Operation enqueue(java.util.List<? extends androidx.work.WorkRequest>);
273 method public abstract androidx.work.Operation enqueueUniquePeriodicWork(String, androidx.work.ExistingPeriodicWorkPolicy, androidx.work.PeriodicWorkRequest);
274 method public androidx.work.Operation enqueueUniqueWork(String, androidx.work.ExistingWorkPolicy, androidx.work.OneTimeWorkRequest);
275 method public abstract androidx.work.Operation enqueueUniqueWork(String, androidx.work.ExistingWorkPolicy, java.util.List<androidx.work.OneTimeWorkRequest!>);
276 method @Deprecated public static androidx.work.WorkManager getInstance();
277 method public static androidx.work.WorkManager getInstance(android.content.Context);
278 method public abstract com.google.common.util.concurrent.ListenableFuture<java.lang.Long!> getLastCancelAllTimeMillis();
279 method public abstract androidx.lifecycle.LiveData<java.lang.Long!> getLastCancelAllTimeMillisLiveData();
280 method public abstract com.google.common.util.concurrent.ListenableFuture<androidx.work.WorkInfo!> getWorkInfoById(java.util.UUID);
281 method public abstract androidx.lifecycle.LiveData<androidx.work.WorkInfo!> getWorkInfoByIdLiveData(java.util.UUID);
282 method public abstract com.google.common.util.concurrent.ListenableFuture<java.util.List<androidx.work.WorkInfo!>!> getWorkInfosByTag(String);
283 method public abstract androidx.lifecycle.LiveData<java.util.List<androidx.work.WorkInfo!>!> getWorkInfosByTagLiveData(String);
284 method public abstract com.google.common.util.concurrent.ListenableFuture<java.util.List<androidx.work.WorkInfo!>!> getWorkInfosForUniqueWork(String);
285 method public abstract androidx.lifecycle.LiveData<java.util.List<androidx.work.WorkInfo!>!> getWorkInfosForUniqueWorkLiveData(String);
286 method public static void initialize(android.content.Context, androidx.work.Configuration);
287 method public abstract androidx.work.Operation pruneWork();
288 }
289
290 public abstract class WorkRequest {
291 method public java.util.UUID getId();
292 field public static final long DEFAULT_BACKOFF_DELAY_MILLIS = 30000L; // 0x7530L
293 field public static final long MAX_BACKOFF_MILLIS = 18000000L; // 0x112a880L
294 field public static final long MIN_BACKOFF_MILLIS = 10000L; // 0x2710L
295 }
296
Rahul Ravikumar15f468c2019-08-30 15:09:02 -0700297 public abstract static class WorkRequest.Builder<B extends androidx.work.WorkRequest.Builder<?, ?>, W extends androidx.work.WorkRequest> {
Alan Viverettecd1aae02019-08-28 15:28:57 -0400298 method public final B addTag(String);
299 method public final W build();
300 method public final B keepResultsForAtLeast(long, java.util.concurrent.TimeUnit);
301 method @RequiresApi(26) public final B keepResultsForAtLeast(java.time.Duration);
302 method public final B setBackoffCriteria(androidx.work.BackoffPolicy, long, java.util.concurrent.TimeUnit);
303 method @RequiresApi(26) public final B setBackoffCriteria(androidx.work.BackoffPolicy, java.time.Duration);
304 method public final B setConstraints(androidx.work.Constraints);
305 method public B setInitialDelay(long, java.util.concurrent.TimeUnit);
306 method @RequiresApi(26) public B setInitialDelay(java.time.Duration);
307 method public final B setInputData(androidx.work.Data);
Alan Viverettecd1aae02019-08-28 15:28:57 -0400308 }
309
310 public abstract class Worker extends androidx.work.ListenableWorker {
311 ctor @Keep public Worker(android.content.Context, androidx.work.WorkerParameters);
312 method @WorkerThread public abstract androidx.work.ListenableWorker.Result doWork();
313 method public final com.google.common.util.concurrent.ListenableFuture<androidx.work.ListenableWorker.Result!> startWork();
314 }
315
316 public abstract class WorkerFactory {
317 ctor public WorkerFactory();
318 method public abstract androidx.work.ListenableWorker? createWorker(android.content.Context, String, androidx.work.WorkerParameters);
319 }
320
321 public final class WorkerParameters {
322 method public java.util.UUID getId();
323 method public androidx.work.Data getInputData();
324 method @RequiresApi(28) public android.net.Network? getNetwork();
325 method @IntRange(from=0) public int getRunAttemptCount();
326 method public java.util.Set<java.lang.String!> getTags();
327 method @RequiresApi(24) public java.util.List<java.lang.String!> getTriggeredContentAuthorities();
328 method @RequiresApi(24) public java.util.List<android.net.Uri!> getTriggeredContentUris();
329 }
330
331}
332