Record Class InvocationContext<T extends GenericInteractionCreateEvent>

java.lang.Object
java.lang.Record
io.github.kaktushose.jdac.dispatching.context.InvocationContext<T>
Type Parameters:
T - The used type of GenericInteractionCreateEvent
Record Components:
event - the underlying jda event
keyValueStore - the KeyValueStore belonging to this interaction over its whole lifetime
definition - the InteractionDefinition defining this interaction (referring to the user defined method)
replyConfig - the InteractionDefinition.ReplyConfig to use
rawArguments - the arguments used to call the final user defined method via Invokable.invoke(java.lang.Object, io.github.kaktushose.jdac.dispatching.context.InvocationContext)
All Implemented Interfaces:
ErrorMessageFactory.ErrorContext
public record InvocationContext<T extends GenericInteractionCreateEvent>(T extends GenericInteractionCreateEvent event, KeyValueStore keyValueStore, InteractionDefinition definition, InteractionDefinition.ReplyConfig replyConfig, SequencedCollection<@Nullable Object> rawArguments) extends Record implements ErrorMessageFactory.ErrorContext
Bundles data that is important for the execution of an interaction, especially for invoking the user defined method.

  • Constructor Details

  • Method Details

    • arguments

      public SequencedCollection<@Nullable Object> arguments()
      Returns:
      same as data()#rawArguements but with Optionals replaced by null

    • cancel

      public void cancel(MessageCreateData errorMessage)
      Stops further execution of this invocation at the next suitable moment.
      Parameters:
      errorMessage - the error message that should be sent to the user as a reply
      Implementation Note:
      This will interrupt the current event thread

    • cancel

      public void cancel(MessageTopLevelComponent component, Entry... placeholders)
      Stops further execution of this invocation at the next suitable moment.
      Parameters:
      component - the MessageTopLevelComponent that should be sent to the user as an error message
      placeholders - the Entry placeholders to use for message resolution
      Implementation Note:
      This will interrupt the current event thread

    • cancelled

      public boolean cancelled()
      Returns:
      if the current invocation is canceled

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • event

      public T event()
      Returns the value of the event record component.
      Specified by:
      event in interface ErrorMessageFactory.ErrorContext
      Returns:
      the value of the event record component

    • keyValueStore

      public KeyValueStore keyValueStore()
      Returns the value of the keyValueStore record component.
      Returns:
      the value of the keyValueStore record component

    • definition

      public InteractionDefinition definition()
      Returns the value of the definition record component.
      Specified by:
      definition in interface ErrorMessageFactory.ErrorContext
      Returns:
      the value of the definition record component

    • replyConfig

      public InteractionDefinition.ReplyConfig replyConfig()
      Returns the value of the replyConfig record component.
      Returns:
      the value of the replyConfig record component

    • rawArguments

      public SequencedCollection<@Nullable Object> rawArguments()
      Returns the value of the rawArguments record component.
      Returns:
      the value of the rawArguments record component