Skip to content

Commit

Permalink
refactor: removed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TomasGnG committed Sep 30, 2023
1 parent 18713c5 commit cc9135e
Showing 1 changed file with 0 additions and 54 deletions.
54 changes: 0 additions & 54 deletions src/main/java/de/efi23a/bot/features/alert/AlertFeature.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,30 +27,13 @@
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

/**
* Alert Feature von Tomas Keder.
*/
@Component
@RequiredArgsConstructor
public class AlertFeature {

/**
* Die Channel-ID für die Erinnerungen.
*/
private static final String ALERT_CHANNEL_ID = "ALERT_CHANNEL_ID";
/**
* Die Rollen-ID, die gepingt werden soll.
*/
private static final String ALERT_ROLE_ID = "ALERT_ROLE_ID";
/**
* Die Zeit (in Stunden), wann die erste Erinnerung abgeschickt werden soll.
* Optimal: 72 Stunden → Unter 72 Stunden wird eine Erinnerung geschickt.
*/
private static final String ALERT_FIRST_REMINDER = "ALERT_FIRST_REMINDER";
/**
* Die Zeit (in Stunden), wann die letzte Erinnerung abgeschickt werden soll.
* Optimal: 24 Stunden → Unter 24 Stunden wird eine Erinnerung geschickt.
*/
private static final String ALERT_LAST_REMINDER = "ALERT_LAST_REMINDER";

private final JDA jda;
Expand Down Expand Up @@ -136,24 +119,10 @@ private void startAlertCheckerTask() {
}
}

/**
* Überprüft, ob eine Erinnerung bereits existiert.
*
* @param name Name der Erinnerung
* @return true, falls eine Erinnerung mit dem Namen existiert. false wenn nicht.
*/
public boolean exists(String name) {
return alerts.find(eq("name", name)).first() != null;
}

/**
* Fügt eine neue Erinnerung hinzu.
*
* @param name Name der Erinnerung.
* @param date Datum für die Erinnerung.
* @param description Beschreibung für die Erinnerung.
* @param createdBy Ersteller von der Erinnerung.
*/
public void addAlert(String name, Date date, String description, String createdBy) {
var document = new Document();

Expand All @@ -174,13 +143,6 @@ private void updateAlert(Document updatedAlert) {
}
}

/**
* Ändert eine Erinnerung.
*
* @param name Name der Erinnerung.
* @param property Eigenschaft, die geändert werden soll.
* @param value Der neue Wert für die ausgewählte Eigenschaft.
*/
public void editAlert(String name, String property, Object value) {
var filter = eq("name", name);

Expand All @@ -196,22 +158,12 @@ public void editAlert(String name, String property, Object value) {
}
}

/**
* Entfernt eine Erinnerung.
*
* @param name Name der Erinnerung.
*/
public void removeAlert(String name) {
if (exists(name)) {
alerts.deleteOne(eq("name", name));
}
}

/**
* Gibt alle hinzugefügten Erinnerungen zurück.
*
* @return alle hinzugefügten Erinnerungen.
*/
public FindIterable<Document> getAlerts() {
return alerts.find();
}
Expand Down Expand Up @@ -245,12 +197,6 @@ private void sendAlert(Document alert) {
.setEmbeds(embed).queue();
}

/**
* Gibt eine Embed Message für eine Erinnerung zurück.
*
* @param name Name der Erinnerung.
* @return EmbedMessage für die Erinnerung.
*/
public MessageEmbed getAlertEmbedMessage(String name) {
var alert = getAlertByName(name);
return new EmbedBuilder()
Expand Down

0 comments on commit cc9135e

Please sign in to comment.