Class ConnectionStatusEvent

Name

ConnectionStatusEvent

Hierarchy

ConnectionStatusEvent

Index

Constructors

Methods

getConnectionState getLiberatorUrl getLoginFailReason getUsername

Constructors

constructor

new ConnectionStatusEvent(): ConnectionStatusEvent
Returns ConnectionStatusEvent

Methods

getConnectionState

getConnectionState(): ConnectionState
Returns the new state of a connection the the Liberator.

Returns ConnectionState
The new connection state

getLiberatorUrl

getLiberatorUrl(): string
Returns the URL of the Liberator connection that this status event has been raised for.

Returns string
The Liberator URL.

getLoginFailReason

getLoginFailReason(): LoginFailedReason
Returns the reason for the login attempt failing. It only makes sense to obtain this value if the ConnectionState is LOGINFAILED.

Returns LoginFailedReason
The reason (LoginFailedReason.NONE if not available).

getUsername

getUsername(): string
Returns the username that will be used to log in to the Liberator.

Returns string
The username. This is only available when the ConnectionState is CredentialsRetrieved.

Generated using TypeDoc