com.alpineclient.plugin.api.objects

Class Notification

java.lang.Object

com.alpineclient.plugin.api.objects.Notification

public final class Notification
extends java.lang.Object

Represents an object that displays a toast popup on the user's screen.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.Builder Builder for Notification.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COLOR The default color used in Notification.Builder.
static long	DEFAULT_DISPLAY_DURATION The default display duration used in Notification.Builder.
static ClientResource	DEFAULT_TEXTURE The default display icon used in Notification.Builder.

Method Summary

Modifier and Type	Method and Description
static @NotNull Notification.Builder	builder() Begins a new builder of this class.
boolean	equals(java.lang.Object obj)
int	getColor() Get the color of the notification.
@NotNull java.lang.String	getDescription() Get the description of the notification.
long	getDuration() Get the duration of the notification in milliseconds.
@NotNull ClientResource	getTexture() Get the texture of the notification.
@Nullable java.lang.String	getTitle() Get the title of the notification.
int	hashCode()
@NotNull java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COLOR

public static final int DEFAULT_COLOR

The default color used in Notification.Builder.

DEFAULT_DISPLAY_DURATION

public static final long DEFAULT_DISPLAY_DURATION

The default display duration used in Notification.Builder.

See Also:

Constant Field Values

DEFAULT_TEXTURE

public static final ClientResource DEFAULT_TEXTURE

The default display icon used in Notification.Builder.

Since:

1.3.0

Method Detail

getTitle

@Nullable
public @Nullable java.lang.String getTitle()

Get the title of the notification.

Returns:

the title

getDescription

@NotNull
public @NotNull java.lang.String getDescription()

Get the description of the notification.

Returns:

the description

getColor

public int getColor()

Get the color of the notification.

Returns:

the color

getDuration

public long getDuration()

Get the duration of the notification in milliseconds.

Returns:

the duration in milliseconds

getTexture

@NotNull
public @NotNull ClientResource getTexture()

Get the texture of the notification.

Returns:

the ClientResource

toString

@NotNull
public @NotNull java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

builder

@NotNull
public static @NotNull Notification.Builder builder()

Begins a new builder of this class.

Returns:

The builder