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

Class AgentDeviceLoginResult

java.lang.Object

com.novomind.ecom.api.iagent.result.AgentDeviceLoginResult

public final class AgentDeviceLoginResult
extends java.lang.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 Summary

Constructors

Constructor	Description
AgentDeviceLoginResult(AgentDevice agentDevice)

Method Summary

Modifier and Type	Method	Description
AgentDevice	getAgentDevice()
java.lang.String	getAttribute(java.lang.String key)	Returns the value to which the specified key is mapped, or null if no mapping for the key exists.
java.util.Set<java.lang.String>	getAttributes()	The method returns all available attributes
boolean	hasOutgoingCallCapability()
AgentDeviceLoginResult	setAttribute(java.lang.String key, java.lang.String value)	The method stores key-value pairs that will be available and accessible to other plugins.
AgentDeviceLoginResult	setOutgoingCallCapability(boolean outgoingCallCapability)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgentDeviceLoginResult

public AgentDeviceLoginResult(AgentDevice agentDevice)

Method Detail

getAgentDevice

public AgentDevice getAgentDevice()

Returns:

the AgentDevice

Since:

11.27

hasOutgoingCallCapability

public boolean hasOutgoingCallCapability()

Returns:

true if the plugin is able to start outgoing calls, otherwise false

Since:

11.27

setOutgoingCallCapability

public AgentDeviceLoginResult setOutgoingCallCapability(boolean outgoingCallCapability)

Parameters:

outgoingCallCapability - the capability of starting outgoing calls

Returns:

the AgentDeviceLoginResult

Since:

11.27

setAttribute

public AgentDeviceLoginResult setAttribute(java.lang.String key,
                                           java.lang.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 java.lang.String getAttribute(java.lang.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 java.util.Set<java.lang.String> getAttributes()

The method returns all available attributes

Returns:

the set of attributes

Since:

11.27