@capawesome/capacitor-battery 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/BatteryPlugin.java

@@ -0,0 +1,156 @@
+package io.capawesome.capacitorjs.plugins.battery;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.battery.classes.events.BatteryLevelChangeEvent;
+import io.capawesome.capacitorjs.plugins.battery.classes.events.BatteryStateChangeEvent;
+import io.capawesome.capacitorjs.plugins.battery.classes.events.LowPowerModeChangeEvent;
+import io.capawesome.capacitorjs.plugins.battery.classes.results.GetBatteryLevelResult;
+import io.capawesome.capacitorjs.plugins.battery.classes.results.GetBatteryStateResult;
+import io.capawesome.capacitorjs.plugins.battery.classes.results.IsLowPowerModeEnabledResult;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.Result;
+
+@CapacitorPlugin(name = "Battery")
+public class BatteryPlugin extends Plugin {
+
+    public static final String EVENT_BATTERY_LEVEL_CHANGE = "batteryLevelChange";
+
+    public static final String EVENT_BATTERY_STATE_CHANGE = "batteryStateChange";
+
+    public static final String EVENT_LOW_POWER_MODE_CHANGE = "lowPowerModeChange";
+
+    public static final String TAG = "BatteryPlugin";
+
+    private static final String ERROR_UNKNOWN_ERROR = "An unknown error occurred.";
+
+    private Battery implementation;
+
+    @Override
+    public void load() {
+        implementation = new Battery(this);
+    }
+
+    @Override
+    @PluginMethod(returnType = PluginMethod.RETURN_NONE)
+    public void addListener(PluginCall call) {
+        super.addListener(call);
+        implementation.startObserving();
+    }
+
+    @PluginMethod
+    public void getBatteryLevel(PluginCall call) {
+        try {
+            NonEmptyResultCallback<GetBatteryLevelResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetBatteryLevelResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.getBatteryLevel(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getBatteryState(PluginCall call) {
+        try {
+            NonEmptyResultCallback<GetBatteryStateResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GetBatteryStateResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.getBatteryState(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void isLowPowerModeEnabled(PluginCall call) {
+        try {
+            NonEmptyResultCallback<IsLowPowerModeEnabledResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull IsLowPowerModeEnabledResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(@NonNull Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+
+            implementation.isLowPowerModeEnabled(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    public void notifyBatteryLevelChangeListeners(@NonNull BatteryLevelChangeEvent event) {
+        notifyListeners(EVENT_BATTERY_LEVEL_CHANGE, event.toJSObject());
+    }
+
+    public void notifyBatteryStateChangeListeners(@NonNull BatteryStateChangeEvent event) {
+        notifyListeners(EVENT_BATTERY_STATE_CHANGE, event.toJSObject());
+    }
+
+    public void notifyLowPowerModeChangeListeners(@NonNull LowPowerModeChangeEvent event) {
+        notifyListeners(EVENT_LOW_POWER_MODE_CHANGE, event.toJSObject());
+    }
+
+    @Override
+    @PluginMethod
+    public void removeAllListeners(PluginCall call) {
+        super.removeAllListeners(call);
+        implementation.stopObserving();
+    }
+
+    @Override
+    @PluginMethod(returnType = PluginMethod.RETURN_NONE)
+    public void removeListener(PluginCall call) {
+        super.removeListener(call);
+        if (!hasAnyListeners()) {
+            implementation.stopObserving();
+        }
+    }
+
+    private boolean hasAnyListeners() {
+        return (
+            hasListeners(EVENT_BATTERY_LEVEL_CHANGE) ||
+            hasListeners(EVENT_BATTERY_STATE_CHANGE) ||
+            hasListeners(EVENT_LOW_POWER_MODE_CHANGE)
+        );
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message);
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @NonNull Result result) {
+        call.resolve(result.toJSObject());
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/CustomException.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.battery.classes;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class CustomException extends Exception {
+
+    @Nullable
+    private final String code;
+
+    public CustomException(@Nullable String code, @NonNull String message) {
+        super(message);
+        this.code = code;
+    }
+
+    @Nullable
+    public String getCode() {
+        return code;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/CustomExceptions.java

@@ -0,0 +1,9 @@
+package io.capawesome.capacitorjs.plugins.battery.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException BATTERY_LEVEL_UNAVAILABLE = new CustomException(
+        null,
+        "The battery level is currently unavailable."
+    );
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/events/BatteryLevelChangeEvent.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.battery.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.Result;
+
+public class BatteryLevelChangeEvent implements Result {
+
+    private final float level;
+
+    public BatteryLevelChangeEvent(float level) {
+        this.level = level;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("level", level);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/events/BatteryStateChangeEvent.java

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.battery.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.Result;
+
+public class BatteryStateChangeEvent implements Result {
+
+    @NonNull
+    private final String state;
+
+    public BatteryStateChangeEvent(@NonNull String state) {
+        this.state = state;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("state", state);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/events/LowPowerModeChangeEvent.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.battery.classes.events;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.Result;
+
+public class LowPowerModeChangeEvent implements Result {
+
+    private final boolean enabled;
+
+    public LowPowerModeChangeEvent(boolean enabled) {
+        this.enabled = enabled;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("enabled", enabled);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/results/GetBatteryLevelResult.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.battery.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.Result;
+
+public class GetBatteryLevelResult implements Result {
+
+    private final float level;
+
+    public GetBatteryLevelResult(float level) {
+        this.level = level;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("level", level);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/results/GetBatteryStateResult.java

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.battery.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.Result;
+
+public class GetBatteryStateResult implements Result {
+
+    @NonNull
+    private final String state;
+
+    public GetBatteryStateResult(@NonNull String state) {
+        this.state = state;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("state", state);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/classes/results/IsLowPowerModeEnabledResult.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.battery.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.battery.interfaces.Result;
+
+public class IsLowPowerModeEnabledResult implements Result {
+
+    private final boolean enabled;
+
+    public IsLowPowerModeEnabledResult(boolean enabled) {
+        this.enabled = enabled;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("enabled", enabled);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.battery.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.battery.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/battery/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.battery.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}