com.github.theholywaffle.teamspeak3.api.event

Class BaseEvent

java.lang.Object

com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

com.github.theholywaffle.teamspeak3.api.event.BaseEvent

All Implemented Interfaces:

TS3Event

Direct Known Subclasses:

ChannelCreateEvent, ChannelDeletedEvent, ChannelDescriptionEditedEvent, ChannelEditedEvent, ChannelMovedEvent, ChannelPasswordChangedEvent, ClientJoinEvent, ClientLeaveEvent, ClientMovedEvent, PrivilegeKeyUsedEvent, ServerEditedEvent, TextMessageEvent

public abstract class BaseEvent
extends Wrapper
implements TS3Event

Field Summary

Fields inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEvent(Wrapper wrapper)

Method Summary

Modifier and Type	Method and Description
int	getInvokerId() Gets the ID of the client who caused this event to happen.
String	getInvokerName() Gets the nickname of the client who caused this event to happen.
String	getInvokerUniqueId() Gets the unique identifier of the client who caused this event to happen.
int	getReasonId() Gets the reason ID of the cause of this event.
String	getReasonMessage() Gets the reason for this event.

Methods inherited from class com.github.theholywaffle.teamspeak3.api.wrapper.Wrapper

get, get, getBoolean, getBoolean, getDouble, getDouble, getInt, getInt, getLong, getLong, getMap, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.theholywaffle.teamspeak3.api.event.TS3Event

fire

Constructor Detail

BaseEvent

protected BaseEvent(Wrapper wrapper)

Method Detail

getInvokerId

public int getInvokerId()

Gets the ID of the client who caused this event to happen.

Because not all events are caused by clients, not all events have an invoker.
Most importantly, client events (i.e. ClientJoinEvent, ClientLeaveEvent ClientMovedEvent) do not have an invoker if a client joined, quit or changed channels themselves. These values are only present if another client caused the event to happen by moving, kicking or banning a client.

If the event response does not contain an invoker, this method will return -1.

Returns:

the client ID of the invoker or -1 if the event does not contain an invoker

getInvokerName

public String getInvokerName()

Gets the nickname of the client who caused this event to happen.

Because not all events are caused by clients, not all events have an invoker.
Most importantly, client events (i.e. ClientJoinEvent, ClientLeaveEvent ClientMovedEvent) do not have an invoker if a client joined, quit or changed channels themselves. These values are only present if another client caused the event to happen by moving, kicking or banning a client.

If the event response does not contain an invoker, this method will return an empty string.

Returns:

the nickname of the invoker or an empty string if the event does not contain an invoker

getInvokerUniqueId

public String getInvokerUniqueId()

Gets the unique identifier of the client who caused this event to happen.

Because not all events are caused by clients, not all events have an invoker.
Most importantly, client events (i.e. ClientJoinEvent, ClientLeaveEvent ClientMovedEvent) do not have an invoker if a client joined, quit or changed channels themselves. These values are only present if another client caused the event to happen by moving, kicking or banning a client.

If the event response does not contain an invoker, this method will return an empty string.

Returns:

the unique ID the invoker or an empty string if the event does not contain an invoker

getReasonId

public int getReasonId()

Gets the reason ID of the cause of this event.

Here's an incomplete list of known reason IDs:

Incomplete list of known reason IDs

ID	Description
-1	No reason present
0	No external cause
1	Client was moved (by other client / by creating a new channel)
3	Client timed out
4	Client kicked from a channel or channel deleted
5	Client kicked from the server
6	Client banned from the server
8	Client left the server (no external cause)
10	Virtual server or channel edited
11	Server shut down

Returns:

the reason ID for this event

getReasonMessage

public String getReasonMessage()

Gets the reason for this event. This field is rarely present, even if the reason ID is non-zero.

In case of a client getting kicked or banned, this will return the user-provided reason.

Returns:

the reason for this event or an empty string if no reason message is present