@capawesome/capacitor-alarm 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/alarm/AlarmPlugin.java

@@ -0,0 +1,154 @@
+package io.capawesome.capacitorjs.plugins.alarm;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.getcapacitor.annotation.Permission;
+import io.capawesome.capacitorjs.plugins.alarm.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.alarm.classes.options.CreateAlarmOptions;
+import io.capawesome.capacitorjs.plugins.alarm.classes.options.CreateTimerOptions;
+import io.capawesome.capacitorjs.plugins.alarm.classes.results.CreateAlarmResult;
+import io.capawesome.capacitorjs.plugins.alarm.classes.results.IsAvailableResult;
+import io.capawesome.capacitorjs.plugins.alarm.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.alarm.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.alarm.interfaces.Result;
+
+@CapacitorPlugin(name = "Alarm", permissions = @Permission(strings = {}, alias = "alarms"))
+public class AlarmPlugin extends Plugin {
+
+    public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+    public static final String TAG = "AlarmPlugin";
+
+    private Alarm implementation;
+
+    @Override
+    public void load() {
+        super.load();
+        this.implementation = new Alarm(this);
+    }
+
+    @PluginMethod
+    public void cancelAlarm(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void createAlarm(PluginCall call) {
+        try {
+            CreateAlarmOptions options = new CreateAlarmOptions(call);
+            NonEmptyResultCallback<CreateAlarmResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull CreateAlarmResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.createAlarm(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void createTimer(PluginCall call) {
+        try {
+            CreateTimerOptions options = new CreateTimerOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.createTimer(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void getAlarms(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void isAvailable(PluginCall call) {
+        try {
+            NonEmptyResultCallback<IsAvailableResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull IsAvailableResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.isAvailable(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void openAlarms(PluginCall call) {
+        try {
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.openAlarms(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        String code = null;
+        if (exception instanceof CustomException) {
+            code = ((CustomException) exception).getCode();
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message, code);
+    }
+
+    private void rejectCallAsUnimplemented(@NonNull PluginCall call) {
+        call.unimplemented("This method is not available on this platform.");
+    }
+
+    private void resolveCall(@NonNull PluginCall call) {
+        call.resolve();
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @Nullable Result result) {
+        if (result == null) {
+            call.resolve();
+        } else {
+            call.resolve(result.toJSObject());
+        }
+    }
+}

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

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.alarm.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/alarm/classes/CustomExceptions.java

@@ -0,0 +1,16 @@
+package io.capawesome.capacitorjs.plugins.alarm.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException DAYS_INVALID = new CustomException(null, "days must contain only valid weekdays.");
+    public static final CustomException DURATION_INVALID = new CustomException(null, "duration must be between 1 and 86400.");
+    public static final CustomException DURATION_MISSING = new CustomException(null, "duration must be provided.");
+    public static final CustomException HOUR_INVALID = new CustomException(null, "hour must be between 0 and 23.");
+    public static final CustomException HOUR_MISSING = new CustomException(null, "hour must be provided.");
+    public static final CustomException MINUTE_INVALID = new CustomException(null, "minute must be between 0 and 59.");
+    public static final CustomException MINUTE_MISSING = new CustomException(null, "minute must be provided.");
+    public static final CustomException NO_CLOCK_APP = new CustomException(
+        "NO_CLOCK_APP",
+        "No app that can handle alarms was found on the device."
+    );
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/alarm/classes/options/CreateAlarmOptions.java

@@ -0,0 +1,124 @@
+package io.capawesome.capacitorjs.plugins.alarm.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSArray;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.alarm.classes.CustomExceptions;
+import java.util.ArrayList;
+import java.util.Calendar;
+
+public class CreateAlarmOptions {
+
+    @Nullable
+    private final ArrayList<Integer> days;
+
+    private final int hour;
+
+    @Nullable
+    private final String label;
+
+    private final int minute;
+
+    private final boolean skipUi;
+
+    @Nullable
+    private final Boolean vibrate;
+
+    public CreateAlarmOptions(@NonNull PluginCall call) throws Exception {
+        JSObject androidOptions = call.getObject("android");
+        this.days = CreateAlarmOptions.getDaysFromCall(call);
+        this.hour = CreateAlarmOptions.getHourFromCall(call);
+        this.label = call.getString("label");
+        this.minute = CreateAlarmOptions.getMinuteFromCall(call);
+        this.skipUi = androidOptions != null && androidOptions.optBoolean("skipUi", false);
+        this.vibrate = androidOptions != null && androidOptions.has("vibrate") ? androidOptions.optBoolean("vibrate", false) : null;
+    }
+
+    @Nullable
+    public ArrayList<Integer> getDays() {
+        return days;
+    }
+
+    public int getHour() {
+        return hour;
+    }
+
+    @Nullable
+    public String getLabel() {
+        return label;
+    }
+
+    public int getMinute() {
+        return minute;
+    }
+
+    public boolean getSkipUi() {
+        return skipUi;
+    }
+
+    @Nullable
+    public Boolean getVibrate() {
+        return vibrate;
+    }
+
+    private static int getCalendarDayFromWeekday(@Nullable String weekday) throws Exception {
+        if (weekday == null) {
+            throw CustomExceptions.DAYS_INVALID;
+        }
+        switch (weekday) {
+            case "FRIDAY":
+                return Calendar.FRIDAY;
+            case "MONDAY":
+                return Calendar.MONDAY;
+            case "SATURDAY":
+                return Calendar.SATURDAY;
+            case "SUNDAY":
+                return Calendar.SUNDAY;
+            case "THURSDAY":
+                return Calendar.THURSDAY;
+            case "TUESDAY":
+                return Calendar.TUESDAY;
+            case "WEDNESDAY":
+                return Calendar.WEDNESDAY;
+            default:
+                throw CustomExceptions.DAYS_INVALID;
+        }
+    }
+
+    @Nullable
+    private static ArrayList<Integer> getDaysFromCall(@NonNull PluginCall call) throws Exception {
+        JSArray days = call.getArray("days");
+        if (days == null) {
+            return null;
+        }
+        ArrayList<Integer> result = new ArrayList<>();
+        for (int index = 0; index < days.length(); index++) {
+            result.add(CreateAlarmOptions.getCalendarDayFromWeekday(days.optString(index, null)));
+        }
+        return result;
+    }
+
+    private static int getHourFromCall(@NonNull PluginCall call) throws Exception {
+        Integer hour = call.getInt("hour");
+        if (hour == null) {
+            throw CustomExceptions.HOUR_MISSING;
+        }
+        if (hour < 0 || hour > 23) {
+            throw CustomExceptions.HOUR_INVALID;
+        }
+        return hour;
+    }
+
+    private static int getMinuteFromCall(@NonNull PluginCall call) throws Exception {
+        Integer minute = call.getInt("minute");
+        if (minute == null) {
+            throw CustomExceptions.MINUTE_MISSING;
+        }
+        if (minute < 0 || minute > 59) {
+            throw CustomExceptions.MINUTE_INVALID;
+        }
+        return minute;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/alarm/classes/options/CreateTimerOptions.java

@@ -0,0 +1,48 @@
+package io.capawesome.capacitorjs.plugins.alarm.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.alarm.classes.CustomExceptions;
+
+public class CreateTimerOptions {
+
+    private final int duration;
+
+    @Nullable
+    private final String label;
+
+    private final boolean skipUi;
+
+    public CreateTimerOptions(@NonNull PluginCall call) throws Exception {
+        JSObject androidOptions = call.getObject("android");
+        this.duration = CreateTimerOptions.getDurationFromCall(call);
+        this.label = call.getString("label");
+        this.skipUi = androidOptions != null && androidOptions.optBoolean("skipUi", false);
+    }
+
+    public int getDuration() {
+        return duration;
+    }
+
+    @Nullable
+    public String getLabel() {
+        return label;
+    }
+
+    public boolean getSkipUi() {
+        return skipUi;
+    }
+
+    private static int getDurationFromCall(@NonNull PluginCall call) throws Exception {
+        Integer duration = call.getInt("duration");
+        if (duration == null) {
+            throw CustomExceptions.DURATION_MISSING;
+        }
+        if (duration < 1 || duration > 86400) {
+            throw CustomExceptions.DURATION_INVALID;
+        }
+        return duration;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/alarm/classes/results/CreateAlarmResult.java

@@ -0,0 +1,25 @@
+package io.capawesome.capacitorjs.plugins.alarm.classes.results;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.alarm.interfaces.Result;
+import org.json.JSONObject;
+
+public class CreateAlarmResult implements Result {
+
+    @Nullable
+    private final String id;
+
+    public CreateAlarmResult(@Nullable String id) {
+        this.id = id;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("id", id == null ? JSONObject.NULL : id);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/alarm/classes/results/IsAvailableResult.java

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

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

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

package/android/src/main/java/io/capawesome/capacitorjs/plugins/alarm/interfaces/EmptyCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.alarm.interfaces;
+
+public interface EmptyCallback extends Callback {
+    void success();
+}

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

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.alarm.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/alarm/interfaces/Result.java

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