Package com.inductiveautomation.ignition.common.rpc

Record Class RpcCall

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.rpc.RpcCall
Record Components:
moduleId - PLATFORM_MODULE_ID for 'platform' level calls, otherwise the module ID.
packageId - An arbitrary string acting as a namespace within the module.
function - The name, case-sensitive, of the function to be invoked. Overloads are not differentiated.
public record RpcCall(@NotNull String moduleId, @NotNull String packageId, @NotNull String function) extends Record
Metadata for a given RPC call, identifying the target function to be invoked.

  • Constructor Details

    • RpcCall

      public RpcCall(@NotNull @NotNull String moduleId, @NotNull @NotNull String packageId, @NotNull @NotNull String function)
      Creates an instance of a RpcCall record class.
      Parameters:
      moduleId - the value for the moduleId record component
      packageId - the value for the packageId record component
      function - the value for the function record component

  • Method Details

    • 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.

    • moduleId

      @NotNull public @NotNull String moduleId()
      Returns the value of the moduleId record component.
      Returns:
      the value of the moduleId record component

    • packageId

      @NotNull public @NotNull String packageId()
      Returns the value of the packageId record component.
      Returns:
      the value of the packageId record component

    • function

      @NotNull public @NotNull String function()
      Returns the value of the function record component.
      Returns:
      the value of the function record component