Class AuthenticationStatus

• TopLevel.Object
  • dw.customer.AuthenticationStatus

Holds the status of an authentication process.

Constant Summary 

Constant	Description
AUTH_OK: String = “AUTH_OK”	Authentication was successful
ERROR_CUSTOMER_DISABLED: String = “ERROR_CUSTOMER_DISABLED”	customer could be found, but is disabled.
ERROR_CUSTOMER_LOCKED: String = “ERROR_CUSTOMER_LOCKED”	customer could be found, but is locked (too many failed login attempts).
ERROR_CUSTOMER_NOT_FOUND: String = “ERROR_CUSTOMER_NOT_FOUND”	customer could not be found
ERROR_PASSWORD_EXPIRED: String = “ERROR_PASSWORD_EXPIRED”	Password does match, but is expired.
ERROR_PASSWORD_MISMATCH: String = “ERROR_PASSWORD_MISMATCH”	the used password is not correct
ERROR_UNKNOWN: String = “ERROR_UNKNOWN”	Any other error

Property Summary 

Property	Description
authenticated: Boolean (read-only)	checks whether the authentication was successful or not
customer: Customer (read-only)	The customer, corresponding to the login used during authentication.
status: String (read-only)	the status code (see the constants above)

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

Method	Description
getCustomer()	The customer, corresponding to the login used during authentication.
getStatus()	the status code (see the constants above)
isAuthenticated()	checks whether the authentication was successful or not

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 

AUTH_OK 

AUTH_OK: String = "AUTH_OK"

Authentication was successful

---

ERROR_CUSTOMER_DISABLED 

ERROR_CUSTOMER_DISABLED: String = "ERROR_CUSTOMER_DISABLED"

customer could be found, but is disabled. Password was not verified.

---

ERROR_CUSTOMER_LOCKED 

ERROR_CUSTOMER_LOCKED: String = "ERROR_CUSTOMER_LOCKED"

customer could be found, but is locked (too many failed login attempts). Password was verified before.

---

ERROR_CUSTOMER_NOT_FOUND 

ERROR_CUSTOMER_NOT_FOUND: String = "ERROR_CUSTOMER_NOT_FOUND"

customer could not be found

---

ERROR_PASSWORD_EXPIRED 

ERROR_PASSWORD_EXPIRED: String = "ERROR_PASSWORD_EXPIRED"

Password does match, but is expired.

---

ERROR_PASSWORD_MISMATCH 

ERROR_PASSWORD_MISMATCH: String = "ERROR_PASSWORD_MISMATCH"

the used password is not correct

---

ERROR_UNKNOWN 

ERROR_UNKNOWN: String = "ERROR_UNKNOWN"

Any other error

---

Property Details 

authenticated 

authenticated: Boolean (read-only)

checks whether the authentication was successful or not

---

customer 

customer: Customer (read-only)

The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.

---

status 

status: String (read-only)

the status code (see the constants above)

---

Method Details 

getCustomer() 

getCustomer(): Customer

The customer, corresponding to the login used during authentication. This customer is not logged in after authentication.

Returns:

• the customer described by the login

---

getStatus() 

getStatus(): String

the status code (see the constants above)

Returns:

• the status code

---

isAuthenticated() 

isAuthenticated(): Boolean

checks whether the authentication was successful or not

Returns:

• the when the authentication was successful

---