Contents

Handling Events, Callbacks, and Completions

Handling Events, Callbacks, and Completions 

Overview 

Handling events that happen with the SDK can allow for a richer UX experience for your end users. We recommend you handle each event (if applicable) that happen within each component of the library.

Before continuing, make sure you have read Integrating Push Notifications to allow for proper remote event handling involving the AuthenticatorManager and AuthRequestManager. Opting to skip this section will only allow for local events to trigger.

Many of our method calls are asynchronous events. As such, they should be handled appropriately to correctly display the proper information back to the end-user. Both platforms handle each event in a similar manner internally but may require different approaches.

For Android, we allow for EventCallback and Event objects to be registered with the appropriate manager. Some method calls also allow for specific EventCallback and Callback objects to be passed in as an argument callback. Be careful when using both the event system through the SDK’s managers and the callback approach as this may lead to multiple calls to the same event.

For iOS, we allow for Completion blocks to be included in many of our function calls. Observers can also be registered through the NSNotificationCenter.

Authentication Management Events 

These events are triggered through calls involving the AuthenticatorManager.

Each EventCallback has an onSuccess() and onFailure() method. They may also be registered as events by the manager.

EventCallbacks for AuthenticatorManager
EventCallback	Description	onSuccess()	onFailure()
DeviceLinkedEventCallback	Notified after the current device gets linked	Device (The current device)	Exception
DeviceUnlinkedEventCallback	Notified after the current device gets unlinked	Device (The current device)	Exception
EndAllSessionsEventCallback	Notified after endAllSessions() finishes	Void	Exception
EndSessionEventCallback	Notified after endSession() finishes	Session	Exception
GetDevicesEventCallback	Notified after getDevices() finishes	List<Device>	Exception
GetSessionsEventCallback	Notified after getSessions() finishes	List<Session>	Exception
UnlinkDeviceEventCallback (Any Device was unlinked)	Notified when any device for this user is unlinked and push is turned on	Device (The unlinked device)	Exception

Each completion block will return information relating to the method being called.

Completion Blocks for AuthenticatorManager
Completion Block	Description	Parameters
completion	Returned after linkDevice call, unlinkDevice call	NSError
endLKCSessionCompletion	Returned after endSession call	NSError
getLKCSessionsCompletion	Returned after getSessions call	NSArray of LKCSession objects, NSError
getDevicesCompletionLKC	Returned after getDevices call	NSArray of LKCDevice objects, NSError

Example: A user links the current device and unlinks any device 

DeviceLinkedEventCallback deviceLinkedEventCallback = new DeviceLinkedEventCallback() {
    @Override public void onSuccess(Device device) {
        showDeviceLinked(device);
    }

    @Override public void onFailure(@NonNull Exception e) {
        showFailure(e);
    }
};

UnlinkDeviceEventCallback unlinkDeviceEventCallback = new UnlinkDeviceEventCallback() {
    @Override public void onSuccess(Device device) {
        showDeviceUnlinked(device);
    }

    @Override public void onFailure(@NonNull Exception e) {
        showFailure(e);
    }
};

@Override
public void onResume() {
    super.onResume();
    authenticatorManager.registerForEvents(deviceLinkedEventCallback, unlinkDeviceEventCallback);
    refreshLinkStatus();
}

@Override
public void onPause() {
    authenticatorManager.unregisterForEvents(deviceLinkedEventCallback, unlinkDeviceEventCallback);
    super.onPause();
}

-(void)linkDevice
{
    [[LKCAuthenticatorManager sharedClient] linkDevice:@"ABC1234" withSDKKey:@"sdkKey" withDeviceName:@"iPhone" deviceNameOverride:YES withCompletion:^(NSError *error)
    {
        if(error == nil)
        {
            // Link was successful
        }
    }];
}

-(void)unlinkDevice
{
  [[LKCAuthenticatorManager sharedClient] unlinkDevice:deviceToUnlink withCompletion:^(NSError *error){
        if(error == nil)
        {
            // Unlink was successful
        }
  }];
}

func linkDevice()
{
    LKCAuthenticatorManager.sharedClient().linkDevice("ABC1234", withSDKKey:"sdkKey",  withDeviceName: "iPhone", deviceNameOverride:true, withCompletion: { (error) in
            if((error) == nil)
            {
                // Link was successful
            }
        })
}

func unlinkDevice()
{
    LKCAuthenticatorManager.sharedClient().unlinkDevice(deviceToUnlink, withCompletion: { (error) in

      if((error) == nil)
      {
            // Unlink was successful
      }
    })
}

Auth Request Management Events 

These events are triggered through calls involving the AuthRequestManager.

Each have an onSuccess() and onFailure() method. They may also be registered as events by the manager.

Events & EventCallbacks for AuthRequestManager
Event / EventCallback	Description	onSuccess()	onFailure()
AuthRequestPushReceivedEvent	Notified when a push notification is received for an auth request	Void	Exception
AuthRequestResponseEvent	Notified after the End User has attempted to respond to a pending Auth Request	AuthRequestResponse	Exception
GetAuthRequestEventCallback	Notified after a check is made to obtain a pending Auth Request	AuthRequest	Exception

Each completion block will return information relating to the method being called.

Completion Blocks for AuthRequestManager
Completion Block	Description	Parameters
checkForPendingAuthRequestCompletion	Returned after checkAuthRequestWithCompletion	LKCAuthRequestDetails, NSError
denyAuthCompletion	Returned after denyAndSendWithReasonID call, sendWithCompletion call	NSError

Example: Auth Request received and responded 

AuthRequestResponseEventCallback authRequestResponseEventCallback = new AuthRequestResponseEventCallback() {
    @Override public void onSuccess(@NonNull AuthRequestResponse authRequestResponse) {
        displayAuthRequestResponse(authRequestResponse);
    }

    @Override public void onFailure(@NonNull Exception e) {
        handleFailure(e);
    }
};

GetAuthRequestEventCallback getAuthRequestEventCallback = new GetAuthRequestEventCallback() {
    @Override public void onSuccess(@Nullable AuthRequest authRequest) {
        if (authRequest != null) {
            displayAuthRequest(authRequest);
        }
    }

    @Override public void onFailure(@NonNull Exception e) {
        handleFailure(e);
    }
};

@Override
public void onResume() {
    ...

    authRequestManager.registerForEvents(authRequestResponseEventCallback, getAuthRequestEventCallback);
}

@Override
public void onPause() {
    authRequestManager.unregisterForEvents(authRequestResponseEventCallback, getAuthRequestEventCallback);

    ...
}

// check and get a pending auth request
[[LKCAuthRequestManager sharedManager] checkAuthRequestWithCompletion:^(LKCAuthRequestDetails *requestDetails, NSError *error) {
    ..
}];

// get the auth methods required for verification
NSArray *methods = [[LKCAuthRequestManager sharedManager] getMethodsToVerify];

// accept an auth request
BOOL acceptAuthRequest = [[LKCAuthRequestManager sharedManager] acceptAndSendIfFailed];

// send a response for an auth request
[[LKCAuthRequestManager sharedManager] sendWithCompletion:^(NSError *error) {
    ..
}];

// check and get a pending auth request
LKCAuthRequestManager.shared()?.checkAuthRequest(completion: { (authRequestObject, error) in
    ..
})

// get the auth methods required for verification
var methods = LKCAuthRequestManager.shared()?.getMethodsToVerify() as! NSArray

// accept an auth request
LKCAuthRequestManager.shared()?.acceptAndSendIfFailed()

// send a response for an auth request
LKCAuthRequestManager.shared()?.send(completion: { (error) in
    ..
})

Auth Method Management Events 

These events are triggered through callbacks/completions with certain Auth Method Managers.

PINCodeManager & CircleCodeManager both use the same callbacks. Each callback has a onVerificationSuccess() and onVerificationFailure().

Callbacks for PINCodeManager & CircleCodeManager
Callback	Description	onVerificationSuccess()	onVerificationFailure()
AuthMethodVerificationCallback	Used whenever a user’s auth method must be verified. Called after changeVerificationFlag(), removePINCode(), removeCircleCode() finishes.	null	`AuthMethodFailure`, boolean if an an unlink triggered, boolean if an unlink warning triggered, `Integer` representing attempts remaining before an auto-unlink occurs.
AuthMethodAuthRequestVerificationCallback	Used whenever a user’s auth method must be verified specifically for an auth request.	boolean if an auth request was sent as a result of failing verification of this Auth Method.	boolean if an auth request was sent as a result of failing verification of this Auth Method, `AuthMethodFailure`, boolean if an an unlink triggered, boolean if an unlink warning triggered, `Integer` representing attempts remaining before an auto-unlink occurs.

Some callback calls may have different onSuccess() and onFailure method signatures (i.e. onAddSuccess() vs onRemoveSuccess()).

Callbacks for WearablesManager
Callback	Description	onSuccess()	onFailure()
AddWearableCallback	Used when adding a `Wearable` via `addWearable()`	null	Exception
RemoveWearableCallback	Used when removing a `Wearable` via `removeWearable()`	null	Exception
CancelRemoveWearableCallback	Used when cancelling the removal of a `Wearable` via `cancelRemoveWearable()`	null	Exception
GetAvailableWearablesCallback	Used when getting the available list of `Wearable` objects via `getAvailableWearables()`	`List<Wearable>`	Exception
GetStoredWearablesCallback	Used when getting the set list of `Wearable` objects via `getStoredWearables()`	`List<Wearable>`	Exception
GetWearablesVerificationFlagCallback	Used when getting the `VerificationFlag` via `getVerificationFlag()`	`VerificationFlag`	Exception
ChangeWearablesVerificationFlagCallback	Used when changing the `VerificationFlag` via `changeVerificationFlag()`	`VerificationFlag` (new)	Exception

Callbacks for BiometricManager
Callback	Description	onSuccess()	onFailure()
SetBiometricCallback	Used when setting a `Biometric` via `setBiometric()`	null	`Failure`
AuthMethodVerificationCallback	Used whenever a user’s auth method must be verified. Called after changeVerificationFlag(), removePINCode(), removeCircleCode() finishes.	null	`AuthMethodFailure`, boolean if an an unlink triggered, boolean if an unlink warning triggered, `Integer` representing attempts remaining before an auto-unlink occurs.
AuthMethodAuthRequestVerificationCallback	Used whenever a user’s auth method must be verified specifically for an auth request.	boolean if an auth request was sent as a result of failing verification of this Auth Method.	boolean if an auth request was sent as a result of failing verification of this Auth Method, `AuthMethodFailure`, boolean if an an unlink triggered, boolean if an unlink warning triggered, `Integer` representing attempts remaining before an auto-unlink occurs.

Callbacks for LocationsManager
Callback	Description	onSuccess()	onFailure()
AddLocationCallback	Used when adding a `Location` via `addLocation()`	null	Exception
RemoveLocationCallback	Used when removing a `Location` via `removeLocation()`	null	Exception
CancelRemoveLocationCallback	Used when cancelling the removal of a `Location` via `cancelRemoveLocation()`	null	Exception
GetStoredLocationsCallback	Used when getting the set list of `Location` objects via `getStoredLocations()`	`List<StoredLocation>`	Exception
GetLocationsVerificationFlagCallback	Used when getting the `VerificationFlag` via `getVerificationFlag()`	`VerificationFlag`	Exception
ChangeLocationsVerificationFlagCallback	Used when changing the `VerificationFlag` via `changeVerificationFlag()`	`VerificationFlag` (new)	Exception

Callbacks for GeofencesManager
Callback	Description	onVerificationSuccess()	onVerificationFailure()
AuthMethodAuthRequestVerificationCallback	Used whenever a user’s auth method must be verified specifically for an auth request.	boolean if an auth request was sent as a result of failing verification of this Auth Method.	boolean if an auth request was sent as a result of failing verification of this Auth Method, `AuthMethodFailure`, boolean if an an unlink triggered, boolean if an unlink warning triggered, `Integer` representing attempts remaining before an auto-unlink occurs.

Completion Blocks for LKCPINCodeManager
Completion Block	Description	Parameters
pinCodeCheckCompletion	Returned after removePINCode, verifyPINCode, and changeVerificationFlag	BOOL representing if the check was successful NSError if there is an error, BOOL representing if the auto-unlink warning threshold is triggered, `int` representing attempts remaining before an auto-unlink occurs

Completion Blocks for LKCCircleCodeManager
Completion Block	Description	Parameters
circleCodeCheckCompletion	Returned after removeCircleCode, verifyCircleCode, and changeVerificationFlag	BOOL representing if the check was successful NSError if there is an error, BOOL representing if the auto-unlink warning threshold is triggered, `int` representing attempts remaining before an auto-unlink occurs

Completion Blocks for LKCLocationsManager
Completion Block	Description	Parameters
removeLocationCompletion	Returned after removeLocation	LKCLocation
cancelRemoveLocationCompletion	Returned after cancelRemove	LKCLocation NSString if there is an error,
locationsCheckCompletion	Returned after verifyLocationsForAuthRequest	BOOL representing if the check was successful NSError if there is an error, BOOL representing if the auto-unlink warning threshold is triggered, `int` representing attempts remaining before an auto-unlink occurs
getLocationsCompletion	Returned after getLocationsWithCompletion	NSArray of location objects
verificationFlagCompletion	Returned after changeVerificationFlagWithCompletion	NSString representing the time remaining

Completion Blocks for LKCWearablesManager
Completion Block	Description	Parameters
wearablesCompletion	Returned after getAvailableWearablesWithCompletion	NSArray of wearable objects NSString representing the error string, if any
addWearableCompletion	Returned after addWearable	NSError
removeWearableCompletion	Returned after removeWearable	LKCWearable
cancelRemoveWearableCompletion	Returned after cancelRemove	LKCLocation NSString if there is an error,
wearablesCheckCompletion	Returned after verifyWearablesForAuthRequest	BOOL representing if the check was successful NSError if there is an error, BOOL representing if the auto-unlink warning threshold is triggered, `int` representing attempts remaining before an auto-unlink occurs
getWearablesCompletion	Returned after getStoredWearablesWithCompletion	NSArray of wearable objects
verificationFlagCompletion	Returned after changeVerificationFlagWithCompletion	NSString representing the time remaining

Completion Blocks for LKCFingerprintScanManager
Completion Block	Description	Parameters
fingerprintScanCompletion	Returned after setFingerprintScanWithVerificationFlag	BOOL representing if the scan was successful NSError if there is an error
fingerprintScanCheckCompletion	Returned after removeFingerprintScanWithCompletion, verifyFingerprintScanForAuthRequest, and changeVerificationFlagWithCompletion	BOOL representing if the check was successful NSError if there is an error, BOOL representing if the auto-unlink warning threshold is triggered, `int` representing attempts remaining before an auto-unlink occurs

Completion Blocks for LKCFaceScanManager
Completion Block	Description	Parameters
faceScanCompletion	Returned after setFaceScanWithVerificationFlag	BOOL representing if the scan was successful NSError if there is an error
faceScanCheckCompletion	Returned after removeFaceScanWithCompletion, verifyFaceScanForAuthRequest, and changeVerificationFlagWithCompletion	BOOL representing if the check was successful NSError if there is an error, BOOL representing if the auto-unlink warning threshold is triggered, `int` representing attempts remaining before an auto-unlink occurs

Handling Events, Callbacks, and Completions

Overview

Authentication Management Events

Example: A user links the current device and unlinks any device

Auth Request Management Events

Example: Auth Request received and responded

Auth Method Management Events

User Contributed