Package dev.sympho.modular_commands.impl.context

Class MessageReplyManager

java.lang.Object

dev.sympho.modular_commands.impl.context.MessageReplyManager

All Implemented Interfaces:

ReplyManager

public class MessageReplyManager
extends Object
implements ReplyManager

Reply manager for message-based commands.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface dev.sympho.modular_commands.api.command.ReplyManager

ReplyManager.EphemeralType

Field Summary

Fields inherited from interface dev.sympho.modular_commands.api.command.ReplyManager

NO_RESPONSE_ERROR

Constructor Summary

Constructors

Constructor	Description
MessageReplyManager(Message original, MessageChannel publicChannel, PrivateChannel privateChannel)	Creates a new manager.

Method Summary

Modifier and Type	Method	Description
Mono<Tuple2<Message,Integer>>	add(MessageCreateSpec spec)	Adds a reply to the chain (either initial or followup).
Mono<Void>	defer()	Defers initial response, indicating to the user that the response is being processed.
Mono<Void>	delete(int index)	Deletes a reply.
Mono<Message>	edit(int index, MessageEditSpec spec)	Edits a reply.
Mono<Message>	get(int index)	Retrieves a reply.
ReplyManager	longTerm()	Obtains a manager that is a continuation of this one and has the same configuration, but is guaranteed to continue working long-term by using alternate sending methods if necessary (for example, it might use regular messages instead of interaction replies).
Mono<Void>	reply(MessageCreateSpec spec)	Sends an initial reply.
ReplyManager	setDeleteDelay(Duration delay)	Sets the delay before deleting new replies, if they are timed.
ReplyManager	setEphemeral(ReplyManager.EphemeralType ephemeral)	Sets whether new replies should be ephemeral.
ReplyManager	setPrivate(boolean priv)	Sets whether new replies should be sent in DMs.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.sympho.modular_commands.api.command.ReplyManager

add, add, delete, edit, edit, edit, edit, edit, get, reply, reply

Constructor Details

MessageReplyManager

@SideEffectFree
public MessageReplyManager(Message original,
 MessageChannel publicChannel,
 PrivateChannel privateChannel)

Creates a new manager.

Parameters:

original - The message that triggered the command.

publicChannel - The public channel to send messages in.

privateChannel - The private channel to send messages in.

Method Details

setPrivate

public ReplyManager setPrivate(boolean priv)

Description copied from interface: ReplyManager

Sets whether new replies should be sent in DMs.

Existing replies are not affected.

Specified by:

setPrivate in interface ReplyManager

Parameters:

priv - If new replies should be sent in a private channel.

Returns:

This.

setEphemeral

public ReplyManager setEphemeral(ReplyManager.EphemeralType ephemeral)

Description copied from interface: ReplyManager

Sets whether new replies should be ephemeral.

Existing replies are not affected.

Specified by:

setEphemeral in interface ReplyManager

Parameters:

ephemeral - The ephemeral type for new replies.

Returns:

This.

setDeleteDelay

public ReplyManager setDeleteDelay(Duration delay)

Description copied from interface: ReplyManager

Sets the delay before deleting new replies, if they are timed.

Existing replies are not affected.

Specified by:

setDeleteDelay in interface ReplyManager

Parameters:

delay - The delay.

Returns:

This.

defer

public Mono<Void> defer()

Description copied from interface: ReplyManager

Defers initial response, indicating to the user that the response is being processed.

Specified by:

defer in interface ReplyManager

Returns:

A Mono that completes after deferral is processed.

reply

public Mono<Void> reply(MessageCreateSpec spec)
                 throws IllegalStateException

Description copied from interface: ReplyManager

Sends an initial reply.

Specified by:

reply in interface ReplyManager

Parameters:

spec - The message specification.

Returns:

A Mono that completes after the reply is sent.

Throws:

IllegalStateException - if an initial reply was already made.

add

public Mono<Tuple2<Message,Integer>> add(MessageCreateSpec spec)

Description copied from interface: ReplyManager

Adds a reply to the chain (either initial or followup).

Specified by:

add in interface ReplyManager

Parameters:

spec - The message specification.

Returns:

The created message and its index.

edit

public Mono<Message> edit(int index,
 MessageEditSpec spec)
                   throws IndexOutOfBoundsException,
IllegalStateException

Description copied from interface: ReplyManager

Edits a reply.

Specified by:

edit in interface ReplyManager

Parameters:

index - The reply index.

spec - The edit specification.

Returns:

The edited message. Fails with an IllegalStateException if the initial reply was deleted.

Throws:

IndexOutOfBoundsException - if there is no reply with that index.

IllegalStateException

get

public Mono<Message> get(int index)
                  throws IndexOutOfBoundsException,
IllegalStateException

Description copied from interface: ReplyManager

Retrieves a reply.

Specified by:

get in interface ReplyManager

Parameters:

index - The reply index.

Returns:

The reply. Fails with an IllegalStateException if the reply was deleted.

Throws:

IndexOutOfBoundsException - if there is no reply with that index.

IllegalStateException

delete

public Mono<Void> delete(int index)
                  throws IndexOutOfBoundsException,
IllegalStateException

Description copied from interface: ReplyManager

Deletes a reply.

Note that this does not change the index of other replies within this manager.

Specified by:

delete in interface ReplyManager

Parameters:

index - The reply index.

Returns:

A Mono that completes when the reply is deleted. Fails with an IllegalStateException if the reply was already deleted.

Throws:

IndexOutOfBoundsException - if there is no reply with that index.

IllegalStateException

longTerm

public ReplyManager longTerm()

Description copied from interface: ReplyManager

Obtains a manager that is a continuation of this one and has the same configuration, but is guaranteed to continue working long-term by using alternate sending methods if necessary (for example, it might use regular messages instead of interaction replies).

Note that, while the existing replies are still accessible (by using ReplyManager.get(int)), editing them may not be possible (for example, an interaction-ephemeral response).

There is no guarantee that the returned manager is independent from this one; using this manager after calling this method causes undefined behavior.

Specified by:

longTerm in interface ReplyManager

Returns:

The long-term manager.