Managing OkVerify start requirements

How to ensure all conditions are met before starting the address verification process

Managing start requirements

For OkVerify to run effectively the following conditions must be met:

1. User grants background location permission

2. Location services must be turned on

3. Google Play Services must be available

Luckily the OkHi core library has helper methods to assist you with these requirements.

Configure OkHi to receive permissions and activity results

public class MainActivity extends AppCompatActivity {

    // Define an OkHi class variable to be used for managing permissions and various other services
    private OkHi okhi;
                    
    private OkVerify okVerify;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        
        // Initialise OkHi to enable requesting of permissions and services. Must be done onCreate
        try {
            okhi = new OkHi(this);
            okVerify = new OkVerify.Builder(this).build();
            int importance = Build.VERSION.SDK_INT >= Build.VERSION_CODES.N ? NotificationManager.IMPORTANCE_DEFAULT : 3;
            OkVerify.init(getApplicationContext(), new OkHiNotification(
                "Verifying your address",
                "We're currently verifying your address. This won't take long",
                "OkHi",
                "OkHi Address Verification",
                "Alerts related to any address verification updates",
                importance,
                1, // notificationId
                2 // notification request code
        ));
        } catch (OkHiException exception) {
            exception.printStackTrace();
        }
    }
    
    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);

        // Pass permission results to okverify
        okhi.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);

        // Pass activity results results to okverify
        okhi.onActivityResult(requestCode, resultCode, data);
    }

}

Check and request for OkVerify start requirements

public class MainActivity extends AppCompatActivity {

    // Define an OkHi class variable to be used for managing permissions and various other services
    OkHi okhi;

    // Define an OkHiLocation that'll be used for verification
    final OkHiLocation workAddress = new OkHiLocation("<okhi_location_id>", -1.313339237582541, 36.842414181487776);

    // Create the OkVerify object variable
    private OkVerify okVerify;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        
        // Initialise OkHi to enable requesting of permissions and services. Must be done onCreate
        try {
            okhi = new OkHi(this);
            okVerify = new OkVerify.Builder(this).build();
            // Should be invoked one time on app start.
            // (optional) OkHiNotification, use to start a foreground service to transmit verification signals to OkHi servers
            int importance = Build.VERSION.SDK_INT >= Build.VERSION_CODES.N ? NotificationManager.IMPORTANCE_DEFAULT : 3;
            OkVerify.init(getApplicationContext(), new OkHiNotification(
                    "Verifying your address",
                    "We're currently verifying your address. This won't take long",
                    "OkHi",
                    "OkHi Address Verification",
                    "Alerts related to any address verification updates",
                    importance,
                    1, // notificationId
                    2 // notification request code
            ));
        } catch (OkHiException exception) {
            exception.printStackTrace();
        }
    }


    // Define a method you'll use to start okverify
    private void startAddressVerification() {
        boolean canStartAddressVerification = canStartAddressVerification();

        // If all the checks pass attempt to start okverify
        if (canStartAddressVerification) {
            // Create an okhi user
            OkHiUser user = new OkHiUser.Builder("[phone]")
                    .withFirstName("Julius")
                    .withLastName("Kiano")
                    .build();

            // Start verification
            okVerify.start(user, workAddress, new OkVerifyCallback<String>() {
                @Override
                public void onSuccess(String result) {
                    showMessage("Successfully started verification for: " + result);
                    startForegroundVerification();
                }

                @Override
                public void onError(OkHiException e) {
                    showMessage("Something went wrong: " + e.getCode());
                }
            });
        }
    }

    class Handler implements OkHiRequestHandler<Boolean> {
        @Override
        public void onResult(Boolean result) {
            if (result) startAddressVerification();
        }
        @Override
        public void onError(OkHiException exception) {
            showMessage(exception.getMessage());
        }
    }

    // Define a method you'll use to check if conditions are met to start okverify - this method will be added in the lib on the next update
    private boolean canStartAddressVerification() {
        Handler requestHandler = new Handler();
        // Check and request user to enable location services
        if (!OkHi.isLocationServicesEnabled(getApplicationContext())) {
            okhi.requestEnableLocationServices(requestHandler);
        } else if (!OkHi.isGooglePlayServicesAvailable(getApplicationContext())) {
            // Check and request user to enable google play services
            okhi.requestEnableGooglePlayServices(requestHandler);
        } else if (!OkHi.isBackgroundLocationPermissionGranted(getApplicationContext())) {
            // Check and request user to grant location permission
            okhi.requestBackgroundLocationPermission("Hey we need  background location permissions", "Pretty please..", requestHandler);
        } else {
            return true;
        }
        return false;
    }

    private void showMessage(String message) {
        Toast.makeText(getApplicationContext(), message, Toast.LENGTH_LONG).show();
    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults);

        // Pass permission results to okverify
        okhi.onRequestPermissionsResult(requestCode, permissions, grantResults);
    }

    @Override
    protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
        super.onActivityResult(requestCode, resultCode, data);

        // Pass activity results results to okverify
        okhi.onActivityResult(requestCode, resultCode, data);
    }

    public void handleButtonTap(View view) {
        startAddressVerification();
    }

    public void stopAddressVerification(View view) {
        OkVerify.stop(getApplicationContext(), workAddress.getId());
    }

    private void startForegroundVerification() {
        try {
            // start a foreground service that'll improve the stability and reliability of verification signals
            OkVerify.startForegroundService(getApplicationContext());
        } catch (OkHiException e) {
            e.printStackTrace();
        }
    }

    private void stopForegroundVerification() {
        // stops the running foreground service
        OkVerify.stopForegroundService(getApplicationContext());
    }

    private boolean checkForegroundService() {
        // checks if the foreground service is running
        return OkVerify.isForegroundServiceRunning(getApplicationContext());
    }
}

Check out our full OkVerify integration example