Package org.netxms.client

Class ChatBot

java.lang.Object
org.netxms.client.ChatBot
public class ChatBot extends Object
Chat bot configuration and status

  • Constructor Details

    • ChatBot

      public ChatBot()
      Create new chat bot object.

    • ChatBot

      protected ChatBot(NXCPMessage msg, long baseId)
      Create chat bot object from NXCP message.
      Parameters:
      msg - NXCP message
      baseId - base field ID

  • Method Details

    • fillMessage

      public void fillMessage(NXCPMessage msg)
      Fill NXCP message with chat bot configuration data.
      Parameters:
      msg - NXCP message

    • getName

      public String getName()
      Returns:
      the name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getDescription

      public String getDescription()
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - the description to set

    • getDriverName

      public String getDriverName()
      Returns:
      the driverName

    • setDriverName

      public void setDriverName(String driverName)
      Parameters:
      driverName - the driverName to set

    • getConfiguration

      public String getConfiguration()
      Returns:
      the configuration

    • setConfiguration

      public void setConfiguration(String configuration)
      Parameters:
      configuration - the configuration to set

    • isDriverActive

      public boolean isDriverActive()
      Returns:
      true if driver instance was successfully created and started

    • isHealthy

      public boolean isHealthy()
      Returns:
      last health check status

    • getIdleTimeout

      public int getIdleTimeout()
      Returns:
      session idle timeout in seconds

    • setIdleTimeout

      public void setIdleTimeout(int idleTimeout)
      Parameters:
      idleTimeout - session idle timeout in seconds

    • getProviderSlot

      public String getProviderSlot()
      Returns:
      AI provider slot for bot sessions (empty string for default)

    • setProviderSlot

      public void setProviderSlot(String providerSlot)
      Parameters:
      providerSlot - AI provider slot for bot sessions (empty string for default)

    • getActiveSessionCount

      public int getActiveSessionCount()
      Returns:
      number of currently active chat sessions

    • getLastInboundMessageTime

      public Date getLastInboundMessageTime()
      Returns:
      time of last inbound message (null if none received)

    • getErrorMessage

      public String getErrorMessage()
      Returns:
      last error message

    • getUserMappings

      public Map<String,Integer> getUserMappings()
      Get user mappings (platform peer ID to NetXMS user ID).
      Returns:
      user mappings (live map, can be modified by caller)

    • setUserMappings

      public void setUserMappings(Map<String,Integer> userMappings)
      Set user mappings (platform peer ID to NetXMS user ID).
      Parameters:
      userMappings - new user mappings