Package velox.api.layer1

Interface Layer1ApiAdminAdapter

All Superinterfaces:

Layer1ApiAdminListener

All Known Subinterfaces:

Layer1ApiAdapter

public interface Layer1ApiAdminAdapter
extends Layer1ApiAdminListener

Provides default empty implementations.

Method Summary

Modifier and Type	Method	Description
default void	onConnectionLost(DisconnectionReason reason, String message)	Connection to server lost.
default void	onConnectionRestored()	Connection to server restored.
default void	onLoginFailed(LoginFailedReason reason, String message)	Failed to login with specified credentials
default void	onLoginSuccessful()	Successful login.
default void	onSystemTextMessage(String message, SystemTextMessageType messageType)	Passes the message into Bookmap and shows it as a popup.
default void	onUserMessage(Object data)	Send an upstream event.

Method Details

onLoginFailed

default void onLoginFailed(LoginFailedReason reason,
 String message)

Description copied from interface: Layer1ApiAdminListener

Failed to login with specified credentials

Specified by:

onLoginFailed in interface Layer1ApiAdminListener

Parameters:

reason - reason code

message - test message associated with login fail (may be null)

onLoginSuccessful

default void onLoginSuccessful()

Description copied from interface: Layer1ApiAdminListener

Successful login.

Specified by:

onLoginSuccessful in interface Layer1ApiAdminListener

onConnectionLost

default void onConnectionLost(DisconnectionReason reason,
 String message)

Description copied from interface: Layer1ApiAdminListener

Connection to server lost. Provider can call this method multiple times in sequence if the reason was changed (i.e. from DisconnectionReason.NO_INTERNET to DisconnectionReason.FATAL)

Specified by:

onConnectionLost in interface Layer1ApiAdminListener

Parameters:

reason - reason code

message - text message associated with login disconnection (may be null)

onConnectionRestored

default void onConnectionRestored()

Description copied from interface: Layer1ApiAdminListener

Connection to server restored. A provider should call it only if it previously invoked Layer1ApiAdminListener.onConnectionLost(DisconnectionReason, String)

Specified by:

onConnectionRestored in interface Layer1ApiAdminListener

onSystemTextMessage

default void onSystemTextMessage(String message,
 SystemTextMessageType messageType)

Description copied from interface: Layer1ApiAdminListener

Passes the message into Bookmap and shows it as a popup. It is suitable for 1-time notifications, but for the general case take a look at the notifications API - Layer1ApiSoundAlertMessage

Specified by:

onSystemTextMessage in interface Layer1ApiAdminListener

Parameters:

message - message itself

messageType - message type

See Also:

• Layer1ApiSoundAlertMessage

onUserMessage

default void onUserMessage(Object data)

Description copied from interface: Layer1ApiAdminListener

Send an upstream event. Allows incorporating arbitrary functionality into protocol

Specified by:

onUserMessage in interface Layer1ApiAdminListener

Parameters:

data - Message content