1 files changed, 41 insertions, 0 deletions
diff --git a/fakelocation/src/main/java/foundation/e/privacymodules/fakelocation/IFakeLocationModule.kt b/fakelocation/src/main/java/foundation/e/privacymodules/fakelocation/IFakeLocationModule.kt
new file mode 100644
index 0000000..32906f8
--- /dev/null
+++ b/fakelocation/src/main/java/foundation/e/privacymodules/fakelocation/IFakeLocationModule.kt
@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2022 E FOUNDATION
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package foundation.e.privacymodules.fakelocation
+
+/**
+ * Manage a fake location on the device.
+ */
+interface IFakeLocationModule {
+    /**
+     * Start to fake the location module. Call [setFakeLocation] after to set the fake
+     * position.
+     */
+    fun startFakeLocation()
+
+    /**
+     * Set or update the faked position.
+     * @param latitude the latitude of the fake position in degrees.
+     * @param longitude the longitude of the fake position in degrees.
+     */
+    fun setFakeLocation(latitude: Double, longitude: Double)
+
+    /**
+     * Stop the fake location module, giving back hand to the true location modules.
+     */
+    fun stopFakeLocation()
+}