Module it.auties.whatsappweb4j

Package it.auties.whatsapp.api

Enum Class SocketEvent

java.lang.Object

java.lang.Enum<SocketEvent>

it.auties.whatsapp.api.SocketEvent

All Implemented Interfaces:

Serializable, Comparable<SocketEvent>, Constable

public enum SocketEvent
extends Enum<SocketEvent>

The constants of this enumerated type describe the various types of events regarding a socket

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSE	Called when the socket is closed
ERROR	Called when an unexpected error is thrown, can be used as a safety mechanism
OPEN	Called when the socket is opened
PING	Called when a ping is sent

Method Summary

Modifier and Type	Method	Description
static SocketEvent	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SocketEvent[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPEN

public static final SocketEvent OPEN

Called when the socket is opened

CLOSE

public static final SocketEvent CLOSE

Called when the socket is closed

ERROR

public static final SocketEvent ERROR

Called when an unexpected error is thrown, can be used as a safety mechanism

PING

public static final SocketEvent PING

Called when a ping is sent

Method Details

values

public static SocketEvent[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SocketEvent valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null