Package com.novomind.ecom.api.iagent.result

Class AgentDeviceLoginResult

java.lang.Object
com.novomind.ecom.api.iagent.result.AgentDeviceLoginResult
public final class AgentDeviceLoginResult extends Object
An AgentDeviceLoginResult provides all information about the successful agent login on an agent device. An AgentDeviceLoginResult is provided by the AgentDeviceControlConnector.loginAgent(com.novomind.ecom.api.iagent.request.AgentDeviceLoginRequest) method.
Since:
11.27

  • Constructor Details

    • AgentDeviceLoginResult

      public AgentDeviceLoginResult(AgentDevice agentDevice)
      Constructs a new AgentDeviceLoginResult with the specified agent device.
      Parameters:
      agentDevice - the AgentDevice associated with this login result

  • Method Details

    • getAgentDevice

      public AgentDevice getAgentDevice()
      Returns the AgentDevice associated with this login result.
      Returns:
      the AgentDevice
      Since:
      11.27

    • hasOutgoingCallCapability

      public boolean hasOutgoingCallCapability()
      Returns true if the plugin is able to start outgoing calls, otherwise false.
      Returns:
      true if the plugin is able to start outgoing calls, otherwise false
      Since:
      11.27

    • setOutgoingCallCapability

      public AgentDeviceLoginResult setOutgoingCallCapability(boolean outgoingCallCapability)
      Sets the capability of starting outgoing calls.
      Parameters:
      outgoingCallCapability - the capability of starting outgoing calls
      Returns:
      the AgentDeviceLoginResult
      Since:
      11.27

    • setAttribute

      public AgentDeviceLoginResult setAttribute(String key, String value)
      The method stores key-value pairs that will be available and accessible to other plugins.
      Parameters:
      key - the attribute key
      value - the attribute value
      Returns:
      the AgentDeviceLoginResult
      Since:
      11.27

    • getAttribute

      public String getAttribute(String key)
      Returns the value to which the specified key is mapped, or null if no mapping for the key exists.
      Parameters:
      key - the attribute key
      Returns:
      the value of the attribute or null if no mapping for the key exists
      Since:
      11.27

    • getAttributes

      public Set<String> getAttributes()
      The method returns all available attributes
      Returns:
      the set of attributes
      Since:
      11.27