Package discord4j.core.event.dispatch

Interface DispatchEventMapper

All Known Implementing Classes:

DispatchHandlers

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Experimental
public interface DispatchEventMapper

A transformation between Gateway inbound Dispatch class of payloads to Discord4J core Event instances.

Method Summary

Modifier and Type	Method	Description
static DispatchEventMapper	discardEvents()	Create a DispatchEventMapper that processes updates and records them into the right Store, while not producing any Event downstream.
static DispatchEventMapper	emitEvents()	Create a DispatchEventMapper that processes updates and records them into the right Store, then derives the proper Event.
<D, S, E extends Event> Mono<E>	handle(DispatchContext<D,S> context)	Process a DispatchContext to potentially obtain an Event.
static DispatchEventMapper	noOp()	Create a DispatchEventMapper that doesn't process any dispatches

Method Details

handle

<D,
S,
E extends Event> Mono<E> handle(DispatchContext<D,S> context)

Process a DispatchContext to potentially obtain an Event.

Type Parameters:

D - the Dispatch type

E - the resulting Event type

Parameters:

context - the DispatchContext used with this Dispatch object

Returns:

a Mono of Event mapped from the given DispatchContext object, or empty if no Event is produced. If an error occurs during processing, it is emitted through the Mono.

emitEvents

static DispatchEventMapper emitEvents()

Create a DispatchEventMapper that processes updates and records them into the right Store, then derives the proper Event.

Returns:

a DispatchEventMapper that caches updates and produces Event instances

discardEvents

static DispatchEventMapper discardEvents()

Create a DispatchEventMapper that processes updates and records them into the right Store, while not producing any Event downstream.

Returns:

a DispatchEventMapper that only caches updates

noOp

static DispatchEventMapper noOp()

Create a DispatchEventMapper that doesn't process any dispatches

Returns:

a DispatchEventMapper that does nothing