com.microstrategy.usher

Interface ScannerManager.Callback

Enclosing class:

ScannerManager

public static interface ScannerManager.Callback

An object that wraps the callback for ScannerManager.

Method Summary

Modifier and Type	Method and Description
void	onAccessDenied(java.lang.String resourceName) Called when the scanned data represents physical access or logical access and access has been denied.
void	onAccessGranted(java.lang.String resourceName) Called when the scanned data represents physical access or logical access and access has been granted.
void	onError(DomainException e) Returns a DomainException object when the scanned data is invalid or if there are pending badge conditions to be resolved.
void	onPermissionRequired(java.lang.String badgeName, java.lang.String orgName) Called when the scanned QR code represents logical access that needs the user's confirmation before logging into the website.
void	onSuccess(BadgeEntity badgeEntity) Called when the scanned QR code generated by a badge is valid.
void	onSuccess(boolean readyToPairing) Called when a MicroStrategy Badge Desktop pairing QR code is scanned to initialize the pairing session.
void	onSuccess(java.util.List<BadgeEntity> list) Called when the QR code is scanned from the badge recovery email.
void	onSuccess(ScannerResultEntity scannerResultEntity) Called when the badge is configured to collect third party, generic barcode data.

Method Detail

onSuccess

void onSuccess(java.util.List<BadgeEntity> list)

Called when the QR code is scanned from the badge recovery email. This is effectively the same as recovering all the badges by clicking the badge recovery link in the email.

Parameters:

list - the List of BadgeEntity objects that were recovered through the badge recovery QR code. The badge(s) might require further operations to activate it, such as verifying phone number or username/password validation

onSuccess

void onSuccess(BadgeEntity badgeEntity)

Called when the scanned QR code generated by a badge is valid.

Parameters:

badgeEntity - the BadgeEntity object that represents the identity of a user

onSuccess

void onSuccess(ScannerResultEntity scannerResultEntity)

Called when the badge is configured to collect third party, generic barcode data. Generic data means that the scanned content does not fit into any of the following categories: logical access, physical access, badge recovery, badge validation or Network Manager access.

Parameters:

scannerResultEntity - the ScannerResultEntity object that wraps all of the scanned data associated with the badges installed on the current device. The scanned data will only be sent by badges that have been activated and have no pending badge conditions.

onAccessGranted

void onAccessGranted(java.lang.String resourceName)

Called when the scanned data represents physical access or logical access and access has been granted.

Parameters:

resourceName - the name of the resource that the server has granted the user access to

onAccessDenied

void onAccessDenied(java.lang.String resourceName)

Called when the scanned data represents physical access or logical access and access has been denied.

Parameters:

resourceName - the name of the resource that the server has denied the user access to

onPermissionRequired

void onPermissionRequired(java.lang.String badgeName,
                          java.lang.String orgName)

Called when the scanned QR code represents logical access that needs the user's confirmation before logging into the website.

Parameters:

badgeName - the name of the badge that will be used to log in to the website

orgName - the name of the organization associated with the badge

onSuccess

void onSuccess(boolean readyToPairing)

Called when a MicroStrategy Badge Desktop pairing QR code is scanned to initialize the pairing session. Note: this is not expected to be called unless you are serious enough to implement your own desktop app.

Parameters:

readyToPairing - true if the desktop is ready to input its password to complete the pairing process; false otherwise

onError

void onError(DomainException e)

Returns a DomainException object when the scanned data is invalid or if there are pending badge conditions to be resolved. Typically, if the scanned QR code is invalid, it will throw exception DomainException.INVALID_QR_CODE.

Parameters:

e - See DomainException