com.microstrategy.usher

Class ScannerManager

java.lang.Object

com.microstrategy.usher.ScannerManager

All Implemented Interfaces:

android.arch.lifecycle.LifecycleObserver

public class ScannerManager
extends java.lang.Object
implements android.arch.lifecycle.LifecycleObserver

The ScannerManager class is responsible for handling the scanned QR code or barcode data that is passed via a ScannerData object. ScannerManager supports all formats of scanned data. You do not have to worry about what kinds of data that you have scanned; the scanned data must simply be passed as a ScannerData object for the SDK to consume. Hence, the ScannerManager can be thought of as a black box. To receive the result, a ScannerManager.Callback must be provided. If there is any exception thrown (e.g. due to a badge condition restriction, network connection issue, etc.), ScannerManager.Callback.onError(DomainException) will be called.

ScannerManager supports many use cases. These include:

1. recovering your badge
2. validating a badge QR code
3. conducting physical access
4. conducting logical access
5. accessing Network Manager
6. uploading scanned data to MicroStrategy Identity Server for analytics
7. pairing a mobile phone with MicroStrategy Badge Desktop

Certain use cases require human interaction to confirm the action with the associated badge ID. These are represented in a ScannerData object as optional attributes.

Here is more detail on the following use cases:

1. Recover a badge by scanning the QR code that is shown in the badge recovery email. ScannerManager.Callback.onSuccess(List) will be called with a List of BadgeEntity objects. The only requirement for this use case is that the ScannerData object contains the QR code content in ScannerData.content().

2. Validate a badge QR code by scanning the QR code that is generated by UsherCodeEntity.qrCode(). A valid QR code indicates a valid badge and ScannerManager.Callback.onSuccess(BadgeEntity) will be called with the corresponding BadgeEntity object.

3. Conduct physical access by scanning the QR code that is shown at the entrance of certain physical doors or elevators. If access is granted, ScannerManager.Callback.onAccessGranted(String)} will be called with the resource name. If access is denied, ScannerManager.Callback.onAccessDenied(String)} will be called with the resource name.

4. Conduct logical access by scanning the QR code that is shown on a web SSO login page. If access is granted, ScannerManager.Callback.onAccessGranted(String)} will be called with the resource name. If access is denied, ScannerManager.Callback.onAccessDenied(String)} will be called with the resource name. If access requires user confirmation, ScannerManager.Callback.onPermissionRequired(String, String)} will be called with the corresponding badge and organization name. In this case, it is recommended to show a dialog for users to confirm the action. After the user's confirmation, you can create a new ScannerData object with ScannerData.permissionGranted() set to true.

5. Access Network Manager by scanning the QR code that is shown on the Network Manager portal. This is a similar to normal logical access, except that you might be required to choose a badge to confirm login, if you have more than one admin badge installed on your device. Once a badge is selected, you can specify the corresponding badge by creating a new ScannerData object with ScannerData.badgeId() set to the selected badge ID.

6. Upload the scanned data to MicroStrategy Identity Server for analytics. If the network administrator has turned on the option in Network Manager for collecting third party barcode data, you can upload the scanned data to MicroStrategy Identity Server by simply creating a ScannerData object with the content. You can specify the type of your QR code with ScannerData.type(). If there is no badge that is configured to collect generic QR code data, ScannerManager.Callback.onError(DomainException) with error code DomainException.NO_BADGE_CONFIGURED_FOR_SCANNED_DATA will be returned.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScannerManager.Callback An object that wraps the callback for ScannerManager.

Constructor Summary

Constructors

Constructor and Description
ScannerManager(android.support.v7.app.AppCompatActivity appCompatActivity, ScannerManager.Callback callback) Constructor for a ScannerManager object with the lifecycle and callback set.
ScannerManager(android.support.v4.app.Fragment fragment, ScannerManager.Callback callback) Constructor for a ScannerManager object with the lifecycle and callback set.
ScannerManager(android.arch.lifecycle.Lifecycle lifecycle, ScannerManager.Callback callback) Constructor for a ScannerManager object with the lifecycle and callback set.

Method Summary

Modifier and Type	Method and Description
void	consumeData(ScannerData data) Consumes the ScannerData object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScannerManager

@Inject
public ScannerManager(@Nonnull
                              android.arch.lifecycle.Lifecycle lifecycle,
                              @Nonnull
                              ScannerManager.Callback callback)

Constructor for a ScannerManager object with the lifecycle and callback set.

Parameters:

lifecycle - See Lifecycle

callback - the callback when ScannerManager consumes the ScannerData

ScannerManager

public ScannerManager(@Nonnull
                      android.support.v7.app.AppCompatActivity appCompatActivity,
                      @Nonnull
                      ScannerManager.Callback callback)

Constructor for a ScannerManager object with the lifecycle and callback set.

Parameters:

appCompatActivity - See AppCompatActivity

callback - the callback when ScannerManager consumes the ScannerData

ScannerManager

public ScannerManager(@Nonnull
                      android.support.v4.app.Fragment fragment,
                      @Nonnull
                      ScannerManager.Callback callback)

Constructor for a ScannerManager object with the lifecycle and callback set.

Parameters:

fragment - See Fragment

callback - the callback when ScannerManager consumes the ScannerData

Method Detail

consumeData

public void consumeData(@Nonnull
                        ScannerData data)

Consumes the ScannerData object. Will analyze the type of the scanned data and then 1) save the content if it is a non-MicroStrategy Badge QR code or 2) process the QR code if it is a MicroStrategy Badge QR code.

Parameters:

data - See ScannerData