Class AgentUserStatusCodes

AgentUserStatusCodes contains constants representing status codes that can be used with a Status object to indicate the success or failure of the agent user login process.

See Also:

All Known Subclasses 

AgentUserStatusCodes

Constant Summary 

ConstantDescription
AGENT_USER_NOT_AVAILABLE: String = “AGENT_USER_NOT_AVAILABLE”Indicates that the agent user is not available.
AGENT_USER_NOT_LOGGED_IN: String = “AGENT_USER_NOT_LOGGED_IN”Indicates that the agent user is not logged in.
CREDENTIALS_INVALID: String = “CREDENTIALS_INVALID”Indicates that the given agent user login or password was wrong.
CUSTOMER_DISABLED: String = “CUSTOMER_DISABLED”Indicates that the customer is disabled.
CUSTOMER_UNREGISTERED: String = “CUSTOMER_UNREGISTERED”Indicates that the customer is either not registered or not registered with the current site.
INSECURE_CONNECTION: String = “INSECURE_CONNECTION”Indicates that the current connection is not secure (HTTP instead of HTTPS) and the server is configured to require a secure connection.
INSUFFICIENT_PERMISSION: String = “INSUFFICIENT_PERMISSION”Indicates that the given agent user does not have the permission ‘Login_Agent’ which is required to login to the storefront as an agent user.
LOGIN_SUCCESSFUL: String = “LOGIN_SUCCESSFUL”Indicates that the agent user login was successful.
NO_STOREFRONT: String = “NO_STOREFRONT”Indicates that the current context is not a storefront request.
PASSWORD_EXPIRED: String = “PASSWORD_EXPIRED”Indicates that the given agent user password has expired and needs to be changed in the Business Manager.
USER_DISABLED: String = “USER_DISABLED”Indicates that the agent user account has been disabled in the Business Manager.
USER_LOCKED: String = “USER_LOCKED”Indicates that the agent user account is locked, because the maximum number of failed login attempts was exceeded.

Constructor Summary 

ConstructorDescription
AgentUserStatusCodes()

Method Summary 

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constant Details 

AGENT_USER_NOT_AVAILABLE 

AGENT_USER_NOT_AVAILABLE: String = "AGENT_USER_NOT_AVAILABLE"

Indicates that the agent user is not available.


AGENT_USER_NOT_LOGGED_IN 

AGENT_USER_NOT_LOGGED_IN: String = "AGENT_USER_NOT_LOGGED_IN"

Indicates that the agent user is not logged in.


CREDENTIALS_INVALID 

CREDENTIALS_INVALID: String = "CREDENTIALS_INVALID"

Indicates that the given agent user login or password was wrong.


CUSTOMER_DISABLED 

CUSTOMER_DISABLED: String = "CUSTOMER_DISABLED"

Indicates that the customer is disabled.


CUSTOMER_UNREGISTERED 

CUSTOMER_UNREGISTERED: String = "CUSTOMER_UNREGISTERED"

Indicates that the customer is either not registered or not registered with the current site.


INSECURE_CONNECTION 

INSECURE_CONNECTION: String = "INSECURE_CONNECTION"

Indicates that the current connection is not secure (HTTP instead of HTTPS) and the server is configured to require a secure connection.


INSUFFICIENT_PERMISSION 

INSUFFICIENT_PERMISSION: String = "INSUFFICIENT_PERMISSION"

Indicates that the given agent user does not have the permission 'Login_Agent' which is required to login to the storefront as an agent user.


LOGIN_SUCCESSFUL 

LOGIN_SUCCESSFUL: String = "LOGIN_SUCCESSFUL"

Indicates that the agent user login was successful.


NO_STOREFRONT 

NO_STOREFRONT: String = "NO_STOREFRONT"

Indicates that the current context is not a storefront request.


PASSWORD_EXPIRED 

PASSWORD_EXPIRED: String = "PASSWORD_EXPIRED"

Indicates that the given agent user password has expired and needs to be changed in the Business Manager.


USER_DISABLED 

USER_DISABLED: String = "USER_DISABLED"

Indicates that the agent user account has been disabled in the Business Manager.


USER_LOCKED 

USER_LOCKED: String = "USER_LOCKED"

Indicates that the agent user account is locked, because the maximum number of failed login attempts was exceeded.


Constructor Details 

AgentUserStatusCodes() 

AgentUserStatusCodes()