Polar Help

EventListenerRepository Interface

Introduction

The EventListenerRepository interface provides methods to register and unregister event listeners.

Methods

registerListener

<T extends PolarApiEvent> RegisteredListener<T> registerListener(Class<T> eventClass, Consumer<T> consumer);

Description:

Registers a listener for the specified event class with normal priority.

Parameters:

  • eventClass - The class of the event to listen for.

  • consumer - The consumer that will handle the event.

Returns:

A RegisteredListener instance representing the registered listener.

registerListener (with priority)

<T extends PolarApiEvent> RegisteredListener<T> registerListener(Class<T> eventClass, Consumer<T> consumer, ListenerPriority priority);

Description:

Registers a listener for the specified event class with the specified priority.

Parameters:

  • eventClass - The class of the event to listen for.

  • consumer - The consumer that will handle the event.

  • priority - The priority of the listener.

Returns:

A RegisteredListener instance representing the registered listener.

registerListener (with priority and ignoreCancelled)

<T extends PolarApiEvent> RegisteredListener<T> registerListener(Class<T> eventClass, Consumer<T> consumer, ListenerPriority priority, boolean ignoreCancelled);

Description:

Registers a listener for the specified event class with the specified priority and ignoreCancelled setting.

Parameters:

  • eventClass - The class of the event to listen for.

  • consumer - The consumer that will handle the event.

  • priority - The priority of the listener.

  • ignoreCancelled - Whether to ignore cancelled events.

Returns:

A RegisteredListener instance representing the registered listener.

unregisterListener

<T extends PolarApiEvent> void unregisterListener(RegisteredListener<T> listener);

Description:

Unregisters a previously registered listener.

Parameters:

  • listener - The listener to unregister.

Server InterfaceListenerPriority Enum