new module:models/AuthRequest(type)
Constructs a new AuthRequest
.
Document representing the authentication request type.
Parameters:
Name | Type | Description |
---|---|---|
type |
module:models/AuthRequest.TypeEnum | Type of authentication request: guest, login (credentials), refresh or session. |
- Source:
Members
(readonly) TypeEnum :String
Allowed values for the type
property.
Type:
- String
- Source:
(inner, constant) credentials
value: "credentials"
- Source:
(inner, constant) guest
value: "guest"
- Source:
(inner, constant) refresh
value: "refresh"
- Source:
(inner, constant) session
value: "session"
- Source:
(inner) type :module:models/AuthRequest.TypeEnum
Type of authentication request: guest, login (credentials), refresh or session.
Type:
- module:models/AuthRequest.TypeEnum
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/AuthRequest}
Constructs a AuthRequest
from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data
to obj
if supplied or a new instance if not.
Parameters:
Name | Type | Description |
---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/AuthRequest | Optional instance to populate. |
- Source:
Returns:
The populated AuthRequest
instance.