Record Class ScriptMessage

java.lang.Object
java.lang.Record
com.botwithus.bot.api.isc.ScriptMessage
Record Components:
channel - the channel the message was published on
sender - identifier of the sending script
payload - the message payload
timestamp - epoch millis when the message was created
requestId - correlation ID for request/response patterns, or null for pub/sub
public record ScriptMessage(String channel, String sender, Object payload, long timestamp, String requestId) extends Record
An immutable message sent over a named ISC channel.

  • Constructor Details

    • ScriptMessage

      public ScriptMessage(String channel, String sender, Object payload, long timestamp)
      Backward-compatible constructor for pub/sub messages.

    • ScriptMessage

      public ScriptMessage(String channel, String sender, Object payload, long timestamp, String requestId)
      Creates an instance of a ScriptMessage record class.
      Parameters:
      channel - the value for the channel record component
      sender - the value for the sender record component
      payload - the value for the payload record component
      timestamp - the value for the timestamp record component
      requestId - the value for the requestId record component

  • Method Details

    • isRequest

      public boolean isRequest()
      Returns true if this message is part of a request/response exchange.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • channel

      public String channel()
      Returns the value of the channel record component.
      Returns:
      the value of the channel record component

    • sender

      public String sender()
      Returns the value of the sender record component.
      Returns:
      the value of the sender record component

    • payload

      public Object payload()
      Returns the value of the payload record component.
      Returns:
      the value of the payload record component

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • requestId

      public String requestId()
      Returns the value of the requestId record component.
      Returns:
      the value of the requestId record component