Gallagher Mobile Connect SDK
Public Member Functions | List of all members
com.gallagher.security.mobileaccess.ReaderAttributes Interface Reference

Inherits Parcelable, and com.gallagher.security.mobileaccess.Reader.

Public Member Functions

double getMeasuredPathLoss ()
 
double getManualConnectPathLoss ()
 
double getAutoConnectPathLoss ()
 
ReaderDistance getReaderDistance ()
 
boolean isNfcEnabled ()
 
boolean isBleActionsEnabled ()
 
boolean isBleAutoConnectEnabled ()
 
boolean isBleManualConnectEnabled ()
 
boolean isSecondFactorRequired ()
 
boolean isNfcDiscovery ()
 
- Public Member Functions inherited from com.gallagher.security.mobileaccess.Reader
String getId ()
 
String getName ()
 

Detailed Description

Documents the attributes of a reader at a given time. Classes implementing this should consider the properties as immutable.

Member Function Documentation

◆ getAutoConnectPathLoss()

double com.gallagher.security.mobileaccess.ReaderAttributes.getAutoConnectPathLoss ( )

Auto connect path loss is the value at which BLE auto-connect will apply.

When the measured path loss is less than the configured auto connect path loss, then the SDK will start an automatically requesting access to the reader.

See also
AccessListener
MobileAccess::addAutomaticAccessListener(AutomaticAccessListener)
Returns
The configured auto connect path loss for the reader

◆ getManualConnectPathLoss()

double com.gallagher.security.mobileaccess.ReaderAttributes.getManualConnectPathLoss ( )

Manual connect path loss is the value at which the UI should show and hide readers for connecting via manual connect.

When the measured path loss exceeds configured the manual connect path loss, then the SDK will start an expiry process internally for the reader. Once the reader expires it enters the unavailable state.

See also
ReaderUpdateListener::onReaderUpdated(ReaderAttributes, ReaderUpdateType)
ReaderUpdateType::READER_UNAVAILABLE
MobileAccess::requestAccess(Reader, AccessListener)
Returns
The configured manual connect path loss for the reader

◆ getMeasuredPathLoss()

double com.gallagher.security.mobileaccess.ReaderAttributes.getMeasuredPathLoss ( )
Returns
The currently measured BLE path loss between the Reader and mobile device

◆ getReaderDistance()

ReaderDistance com.gallagher.security.mobileaccess.ReaderAttributes.getReaderDistance ( )
Returns
An enum indicating the distance the reader is calculated from the phone

◆ isBleActionsEnabled()

boolean com.gallagher.security.mobileaccess.ReaderAttributes.isBleActionsEnabled ( )
Returns
A boolean indicating if BLE actions are available to use on this reader

◆ isBleAutoConnectEnabled()

boolean com.gallagher.security.mobileaccess.ReaderAttributes.isBleAutoConnectEnabled ( )
Returns
A boolean indicating if automatic connect is available on this reader

◆ isBleManualConnectEnabled()

boolean com.gallagher.security.mobileaccess.ReaderAttributes.isBleManualConnectEnabled ( )
Returns
A boolean indicating if manual connect is available on this reader

◆ isNfcDiscovery()

boolean com.gallagher.security.mobileaccess.ReaderAttributes.isNfcDiscovery ( )

Returns true if the reader and data was updated via NFC

◆ isNfcEnabled()

boolean com.gallagher.security.mobileaccess.ReaderAttributes.isNfcEnabled ( )
Returns
A boolean indicating if NFC is available to use on this reader

◆ isSecondFactorRequired()

boolean com.gallagher.security.mobileaccess.ReaderAttributes.isSecondFactorRequired ( )
Returns
A boolean indicating if the reader will require a second factor on connection

The documentation for this interface was generated from the following file: