de.griefed.serverpackcreator.spring

Class NotificationResponse

java.lang.Object

de.griefed.serverpackcreator.spring.NotificationResponse

@Component
public class NotificationResponse
extends java.lang.Object

NotificationResponse to be passed back to the requester.

Constructor Summary

Constructors

Constructor and Description
NotificationResponse()

Method Summary

Modifier and Type	Method and Description
java.lang.String	curseResponse(int projectID, int status, java.lang.String message, int timeout, java.lang.String icon, java.lang.String colour) Construct a curseResponse with values acquired from the CurseForge API.
java.lang.String	curseResponse(java.lang.String projectName, int status, java.lang.String message, int timeout, java.lang.String icon, java.lang.String colour) Construct a curseResponse with all values manually set.
java.lang.String	zipResponse(java.util.List<java.lang.String> messages, int timeout, java.lang.String icon, java.lang.String colour, java.lang.String file, boolean success) Construct a zipResponse for replying to a file-upload and display in a quasar notification.
java.lang.String	zipResponse(java.lang.String message, int timeout, java.lang.String icon, java.lang.String colour, java.lang.String file, boolean success) Construct a zipResponse for replying to a file-upload and display in a quasar notification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NotificationResponse

public NotificationResponse()

Method Detail

curseResponse

public java.lang.String curseResponse(java.lang.String projectName,
                                      int status,
                                      java.lang.String message,
                                      int timeout,
                                      java.lang.String icon,
                                      java.lang.String colour)

Construct a curseResponse with all values manually set.

Parameters:

projectName - The name of the CurseForge project.

status - The statuscode. Status 0: Already exists. Status 1: OK, generating. Status 2: Error occurred.

message - The message the requester should care about.

timeout - Timeout in milliseconds after which the notification in our Quasar frontend should disappear.

icon - The icon to be displayed in the notification.

colour - The colour of the notification.

Returns:

String. Returns the aforementioned parameters wrapped in JSON.

curseResponse

public java.lang.String curseResponse(int projectID,
                                      int status,
                                      java.lang.String message,
                                      int timeout,
                                      java.lang.String icon,
                                      java.lang.String colour)

Construct a curseResponse with values acquired from the CurseForge API.

Parameters:

projectID - The id with which to gather the name of the project.

status - The statuscode. Status 0: Already exists. Status 1: OK, generating. Status 2: Error occurred.

message - The message the requester should care about.

timeout - Timeout in milliseconds after which the notification in our Quasar frontend should disappear.

icon - The icon to be displayed in the notification.

colour - The colour of the notification.

Returns:

String. Returns the aforementioned parameters wrapped in JSON.

zipResponse

public java.lang.String zipResponse(java.util.List<java.lang.String> messages,
                                    int timeout,
                                    java.lang.String icon,
                                    java.lang.String colour,
                                    java.lang.String file,
                                    boolean success)

Construct a zipResponse for replying to a file-upload and display in a quasar notification.

Parameters:

messages - List A list of messages.

timeout - Integer The timeout in ms until the message gets automatically discarded.

icon - String The icon to be displayed in the message.

colour - String The colour of the message.

file - String The file name, if available.

success - Boolean To indicate a successfull event or not.

Returns:

String The message formatted in JSON.

zipResponse

public java.lang.String zipResponse(java.lang.String message,
                                    int timeout,
                                    java.lang.String icon,
                                    java.lang.String colour,
                                    java.lang.String file,
                                    boolean success)

Construct a zipResponse for replying to a file-upload and display in a quasar notification.

Parameters:

message - String The message itself.

timeout - Integer The timeout in ms until the message gets automatically discarded.

icon - String The icon to be displayed in the message.

colour - String The colour of the message.

file - String The file name, if available.

success - Boolean To indicate a successfull event or not.

Returns:

String The message formatted in JSON.