summaryrefslogtreecommitdiffstats
path: root/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/scheduler/Scheduler.java
diff options
context:
space:
mode:
Diffstat (limited to 'mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/scheduler/Scheduler.java')
-rw-r--r--mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/scheduler/Scheduler.java48
1 files changed, 48 insertions, 0 deletions
diff --git a/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/scheduler/Scheduler.java b/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/scheduler/Scheduler.java
new file mode 100644
index 0000000000..c7a7afcd2d
--- /dev/null
+++ b/mobile/android/exoplayer2/src/main/java/org/mozilla/thirdparty/com/google/android/exoplayer2/scheduler/Scheduler.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright (C) 2017 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 org.mozilla.thirdparty.com.google.android.exoplayer2.scheduler;
+
+import android.app.Notification;
+import android.app.Service;
+import android.content.Intent;
+
+/** Schedules a service to be started in the foreground when some {@link Requirements} are met. */
+public interface Scheduler {
+
+ /**
+ * Schedules a service to be started in the foreground when some {@link Requirements} are met.
+ * Anything that was previously scheduled will be canceled.
+ *
+ * <p>The service to be started must be declared in the manifest of {@code servicePackage} with an
+ * intent filter containing {@code serviceAction}. Note that when started with {@code
+ * serviceAction}, the service must call {@link Service#startForeground(int, Notification)} to
+ * make itself a foreground service, as documented by {@link
+ * Service#startForegroundService(Intent)}.
+ *
+ * @param requirements The requirements.
+ * @param servicePackage The package name.
+ * @param serviceAction The action with which the service will be started.
+ * @return Whether scheduling was successful.
+ */
+ boolean schedule(Requirements requirements, String servicePackage, String serviceAction);
+
+ /**
+ * Cancels anything that was previously scheduled, or else does nothing.
+ *
+ * @return Whether cancellation was successful.
+ */
+ boolean cancel();
+}