SDK Initialization

• Initialization can begin using the InitializationBuilder to create a builder object which will be used to initialize the SDK, by providing the application context and Sensibill DefaultEnvironment

  • InitializationBuilder builder = new InitializationBuilder(context, sensibill_env)

  • Parameters:

    Name	Description
    context	Application Context
    sensibill_env	An enum conforming to the DefaultEnvironment type. This specifies what external Sensibill environment you wish your application to access. Example DefaultEnvironment.BETA_SANDBOX

• InitializationBuilder can be extended to provide SDK customization and monitoring. Extensions are optional

Initialization Extension: SDK Lifecycle Listener

• Lifecycle events of activities in the SDK can be monitored by host application by providing an AbstractActivityLifecycleListener during initialization.

InitializationBuilder builder = new InitializationBuilder(getApplicationContext(), DefaultEnvironment.BETA_SANDBOX)
    .activityLifecycle(new AbstractActivityLifecycleListener() {
        // implement methods here
    }

Initialization Extension: Token Provider

• Custom token provider can be applied to the SDK by providing an Auth Token Provider. When session time runs out or token is invalid, SDK will use this token provider to retrieve a new token.
• Strategy for providing tokens depends on the Authentication strategy (ie, On-Device Authentication vs Integration Server Authentication). For more detail on authentication: Authentication Strategy

InitializationBuilder builder = new InitializationBuilder(getApplicationContext(), DefaultEnvironment.BETA_SANDBOX)
    .authTokenProvider(new TokenProvider() {
        // implement methods here
    }

Initialization Extension: Event Listener

• SDK events can be monitored by providing an Event Listener during initialization. A class which implements OnTrackEventListener can be passed into InitializationBuilder. SDK events will trigger trackEvent function in said class.

InitializationBuilder builder = new InitializationBuilder(getApplicationContext(), DefaultEnvironment.BETA_SANDBOX)
    builder.onTrackEventListener(new OnTrackEventListener {
        @Override
        public void trackEvent(AnalyticsEvent eventName, Map<String, Object> attributes, Map<String, Object> superAttributes) {
            // Track Event
        }

        @Override
        public void onDestroy() {
            // Handle Tracker Destruction
        }
    });

Initialization Extension: SDK Functional Customization

• Additional SDK functional customizations can be made via FunctionalConfiguration. Set desired functionality, and pass to initialization builder.

FunctionalConfiguration config = new FunctionalConfiguration();
// Example: Disable Exports
config.getFunctionalConfiguration().setEnableExports(false);

InitializationBuilder builder = new InitializationBuilder(getApplicationContext(), DefaultEnvironment.BETA_SANDBOX)
    .configuration(config);

Setting	SDK Affect	Type
setEnableNotifications	show/hide Notifications fragment in receipt list, default will show	Boolean
setEnablePaymentFilter	show/hide Payment filter in search, default will show payment filter	Boolean
setEnableReceiptEmail	show/hide receipt email in receipt list, will show receipt email	Boolean
setEnableFolders	show/hide folders, default will show	Boolean
setEnableFolderSorting	show/hide sorting in folder receipt list, default will show	Boolean
setEnableNotes	show/hide notes, default will show	Boolean
setEnableTags	show/hide user tags in notes, default will show	Boolean
setEnableExports	show/hide exports, default will show	Boolean
setShowSearchInReceiptList	show/hide search in sort in the receipt list, default will show	Boolean
setEnableCurrencyFilter	show/hide currency filter in search, default will show currency filter	Boolean
setReceiptEmailDisplayDomain	set custom domain for receipt email registration	String

Build and Initialize

• Once InitializationBuilder object is created and optional extensions are added, SDK can be initialized by calling the following:

SensibillSDK.getInstance().initialize(builder.build());