public class CoreBootParameter extends Object
ServiceClient.bootCore(CoreBootParameter)
.Modifier and Type | Class and Description |
---|---|
static class |
CoreBootParameter.Builder |
Modifier and Type | Field and Description |
---|---|
String |
apiKey
The WEBFLEET.connect API key.
|
boolean |
automaticDongleActivation
True (by default) if the dongle should be activated as soon as it becomes connected to the smartphone.
|
String |
customerActivationKey
Deprecated.
not needed anymore
|
BluetoothDevice |
dongleBtDevice
A
BluetoothDevice pointing to the dongle. |
String |
password
The password of the user.
|
boolean |
reset
Send this flag with
true to delete all currently stored state data, session-related data and all
buffered messages for all users. |
String |
userName
The user name.
|
String |
webfleetConnectServerHostName
The host name of the WEBFLEET CONNECT service.
|
String |
webfleetMessagingServerHostName
The host name of the WEBFLEET messaging service.
|
int |
webfleetMessagingServerPort
The port of the WEBFLEET messaging service.
|
Constructor and Description |
---|
CoreBootParameter(String userName,
String password,
String apiKey,
boolean reset,
BluetoothDevice dongleBtDevice,
String customerActivationKey,
String webfleetMessagingServerHostName,
int webfleetMessagingServerPort,
String webfleetConnectServerHostName)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static CoreBootParameter.Builder |
builder()
Returns a new
CoreBootParameter.Builder for the CoreBootParameter class. |
public final String userName
UbiErrorCode.USERNAME_MISSING_OR_MALFORMED
is sent back to the client.public final String password
UbiErrorCode.PASSWORD_MISSING_OR_MALFORMED
is sent back to the client.public final String apiKey
UbiErrorCode.API_KEY_MISSING_OR_INVALID
is sent back to the client.public final boolean reset
true
to delete all currently stored state data, session-related data and all
buffered messages for all users. Optional.public final BluetoothDevice dongleBtDevice
BluetoothDevice
pointing to the dongle. The friendly Bluetooth name of the dongle starts with "LINK 100", followed by a dash with leading
and trailing spaces (" - ") and the last four digits of the serial number of the dongle. (subject to change). By filtering on the suffix of the paired
Bluetooth devices (LINK 100*) a custom app could help the user by constraining the number of selectable devices.
It is recommended to let the user pair the dongle with the smartphone via the regular Android Bluetooth pairing process
before passing the Bluetooth device pointing to the dongle to ServiceClient.bootCore(CoreBootParameter)
.
Always required.
If missing the error UbiErrorCode.DONGLE_BT_ADDRESS_MISSING
is sent back to the client.public final String customerActivationKey
UbiErrorCode.CUSTOMER_ACTIVATION_KEY_MISSING
is sent back to the client.public final String webfleetMessagingServerHostName
UbiErrorCode.WEBFLEET_MESSAGING_SERVER_HOST_NAME_MISSING_OR_INVALID
is sent back to the client.public final int webfleetMessagingServerPort
UbiErrorCode.WEBFLEET_MESSAGING_SERVER_PORT_MISSING_OR_INVALID
is sent back to the client.public final String webfleetConnectServerHostName
UbiErrorCode.WEBFLEET_CONNECT_SERVER_HOST_NAME_MISSING_OR_INVALID
is sent back to the client.public final boolean automaticDongleActivation
ServiceClient.startActivation()
has to be called, to start the dongle activation.
This parameter is optional.@Deprecated public CoreBootParameter(String userName, String password, String apiKey, boolean reset, BluetoothDevice dongleBtDevice, String customerActivationKey, String webfleetMessagingServerHostName, int webfleetMessagingServerPort, String webfleetConnectServerHostName)
builder()
instead.public static CoreBootParameter.Builder builder()
CoreBootParameter.Builder
for the CoreBootParameter
class.