Package com.blub0x.BluIDSDK.models

Types

AccessLogItem

data class AccessLogItem(timestamp: ULong, accessStatus: AccessStatus, cardID: String, keySetID: String, macAddress: String)

Used to show the logs of when a user tried to transfer credentials included with other details like the transfer credentials status.

AccessStatus

enum AccessStatus : Enum<AccessStatus>

Status of a transfer credentials operation. Shows whether the access was granted or not or if some error occurred.

AddMobileDeviceResponse

data class AddMobileDeviceResponse(error: BluIDSDKError?, mobileDeviceObject: MobileDeviceObject?)

Response type for registerUserDevice function

AdvertisementSettings

enum AdvertisementSettings : Enum<AdvertisementSettings>

Used for setting and getting the advertising setting of the connected BluPOINT device

AllowAccessType

enum AllowAccessType : Enum<AllowAccessType>

The various types of access modes for gesture based authentication.

BluIDSDK_Environment

enum BluIDSDK_Environment : Enum<BluIDSDK_Environment>

Used to set and get the current environment

BluIDSDKError

data class BluIDSDKError(type: BluIDSDKErrorType, message: String?, code: Int?)

Shows that an error has occurred

BluIDSDKErrorType

enum BluIDSDKErrorType : Enum<BluIDSDKErrorType>

Defines the types of errors that can occur while performing operations on a BluPOINT device.

BluIDSDKException

data class BluIDSDKException(error: BluIDSDKError) : Exception

A custom exception which throws BluIDSDKError when something critical happens

CredentialType

enum CredentialType : Enum<CredentialType>

Type of credential

Device_Details

open class Device_Details(name: String, id: String, firmwareVersion: String, macAddress: String) : Serializable

Stores the details of BluPOINT devices

Device_Firmware

data class Device_Firmware(version: String, isDownloaded: Boolean, releaseDate: Long, isObsolete: Boolean) : Serializable

Stores information about the BluPOINT firmware files

Device_Information

data class Device_Information(id: String, name: String, macAddress: String?, firmwareVersion: String?, tapSettings: GenericBLESettings?, twistSettings: GenericBLESettings?, appSpecificSettings: GenericBLESettings?, waveSettings: GenericBLESettings?, rangeSettings: GenericBLESettings?, aiSettings: GenericBLESettings?, appleWatchSettings: GenericBLESettings?, BluREMOTESettings: GenericBLESettings?, enhancedTapSettings: EnhancedTapSettings?, isWiegandEnabled: Boolean?, signalStrength: Int, readerID: Long?, lastReported: Long)

Used to set and get the device settings and information of BluPOINT devices.

Device_LED

data class Device_LED(color: Device_LED_Color, onTimeInSeconds: Int) : Serializable

Used to set the color and LED duration of a BluPOINT device

Device_LED_Color

data class Device_LED_Color(red: Byte, green: Byte, blue: Byte) : Serializable

Color of the LED of a BluPOINT device

DeviceInformationResponse

data class DeviceInformationResponse(error: BluIDSDKError?, deviceDetails: Device_Details?)

Response type for deviceInformation function

DeviceLEDState

enum DeviceLEDState : Enum<DeviceLEDState>

Used to set and fetch the LED colors for a particular state.

DeviceMode

enum DeviceMode : Enum<DeviceMode>

Used to check the mode of the connected BluPOINT device

DiagnosticLog

data class DiagnosticLog(title: String, time: Long, userDeviceInfo: String, logs: String)

Contains information like connected devices etc. and basic mobile phone information.

EnhancedTapSettings

data class EnhancedTapSettings(enabled: Boolean, iosBackgroundPower: Int, iosForegroundPower: Int, androidPower: Int) : Serializable

Used to set and get the enhanced tap settings of BluPOINT devices

GenericBLESettings

data class GenericBLESettings(power: Int, enabled: Boolean) : Serializable

Class to set or get the power and if gestures are used.

GestureType

enum GestureType : Enum<GestureType>

GetDeviceKeyResponse

data class GetDeviceKeyResponse(error: BluIDSDKError?, data: String?)

Response type for getDeviceKey function

GetDeviceStateLedColorResponse

data class GetDeviceStateLedColorResponse(error: BluIDSDKError?, ledColor: Device_LED_Color?)

Response type for getDeviceStateLedColor function

GetFirmwareVersionOfDeviceResponse

data class GetFirmwareVersionOfDeviceResponse(error: BluIDSDKError?, firmwareVersion: String?)

Response type for getFirmwareVersionOfDevice function

GetKeySetIDResponse

data class GetKeySetIDResponse(error: BluIDSDKError?, id: String?)

Response type for getKeySetID function

GetStrengthResponse

data class GetStrengthResponse(error: BluIDSDKError?, data: Int?)

Response type for getStrength function

LoginResponse

data class LoginResponse(error: BluIDSDKError?, userData: UserData?)

Response type for login function

MobileDeviceInfo

data class MobileDeviceInfo(firebaseToken: String, osVersion: String, deviceModel: String)

Information about the mobile phone the user is using

MobileDeviceObject

data class MobileDeviceObject(resultCode: Int, Description: String)

Response of registerUserDevice

PersonCardDetails

open class PersonCardDetails(personCardID: String, cardName: String, cardID: String, cardACSystemName: String, cardSerialNumber: Int, externalCardNumber: String?, cardType: Int?, issuedBy: String, isDeleted: Boolean, activationDate: Long, deactivationDate: Long, lastUsed: Long, facilityCode: Int, credentialType: CredentialType) : Serializable

Represents existing Card information that belongs to an existing User. Used during the authorization and authentication check of the user

RebootResponse

data class RebootResponse(error: BluIDSDKError?, data: String?)

Response type for reboot function

ScanFilter

data class ScanFilter(signalStrength: Int, callbackGapInMillis: Long) : Serializable

Filters the scan result

SetStrengthResponse

data class SetStrengthResponse(error: BluIDSDKError?, data: Int?)

Response type for setStrength function

SyncPersonCardsResponse

data class SyncPersonCardsResponse(error: BluIDSDKError?, personCardDetails: ArrayList<PersonCardDetails>?)

Response type for syncPersonCards function

UserCredentials

data class UserCredentials(username: String, password: String) : Serializable

Used to login to the environments.

UserData

data class UserData(accessToken: String, tokenType: String, expiresIn: BigInteger, userName: String, issued: String, expires: String) : Serializable

Response data for login function

UserPreferences

data class UserPreferences(allowAccess: AllowAccessType, enableVibrate: Boolean, enableTap: Boolean, enableTwist: Boolean, enableAppSpecific: Boolean, enableWave: Boolean, enableRange: Boolean, enableAI: Boolean, enableAppleWatch: Boolean, enableBluREMOTE: Boolean, enhancedTap: Boolean)

The setting at which the user wants the mobile phone to interact with BluPOINT devices