Class LoginAttemptInformation

A simple class to represent a Login Attempt.

Index

Constructors

Accessors

failReason isSuccessful jwt motd userInformation

Constructors

`Protected`constructor

new LoginAttemptInformation(
isInternalConstructor?: boolean,
): LoginAttemptInformation
Parameters
- OptionalisInternalConstructor: boolean
Returns LoginAttemptInformation

Overrides FrameworkObject.constructor

Accessors

failReason

get failReason(): string

A string that describes the login failure reason.

Returns string

isSuccessful

get isSuccessful(): boolean

Indicates if the login was successful or not.

Returns boolean

jwt

get jwt(): string

The user JWT token. Required for API authenticated requests.

Returns string

motd

get motd(): string

The message of the day, as returned by the server.

Returns string

userInformation

get userInformation(): CloudUserInformation

The currently logged in user information.

Returns CloudUserInformation