Package com.inductiveautomation.ignition.gateway.clientcomm

Class Message

java.lang.Object
com.inductiveautomation.ignition.gateway.clientcomm.Message
public class Message extends Object
A Message represents a request from an Ignition client or designer. Each message has a message type, defined in GatewayConstants, and some named arguments.

  • Constructor Details

    • Message

      public Message()

  • Method Details

    • getType

      public int getType()

    • setType

      public void setType(int i)

    • getVersion

      public long getVersion()

    • setVersion

      public void setVersion(long version)

    • getScope

      public int getScope()

    • setScope

      public void setScope(int scope)

    • addArg

      public void addArg(String name, String value)

    • addIndexedArg

      public void addIndexedArg(String name, String value)

    • getArgLength

      public int getArgLength()
      Returns the number of non-indexed arguments in this message

    • getArg

      public String getArg(String name)
      Returns the value of the named argument. If the argument isn't present, null is returned

    • getWrappedArg

      public String getWrappedArg(String name)
      Like getArg, but returns empty string if the argument wasn't present. Never returns null.

    • getLongArg

      public Long getLongArg(String name)
      Returns the named argument as a Long. Null is returned if the arg doesn't exist, or fails parsing

    • getIntArg

      public Integer getIntArg(String name)
      Returns the named argument as an Integer. Null is returned if the arg doesn't exist, or fails parsing

    • getIndexedArg

      public List<String> getIndexedArg(String name)
      Returns a list of strings representing all of the indexed arguments for the given name. Will return null if there are no indexed values with the given name.

    • getCookie

      public String getCookie()

    • setCookie

      public void setCookie(String cookie)

    • getLocale

      public Locale getLocale()
      Retruns the locale of the calling client

    • setLocaleCodes

      public void setLocaleCodes(String[] localeCode)
      Not part of the public API - used by the MessageParser