View on GitHub

sensibill-android-documentation

Migration Guide

Migration from 1.20.0 to 1.21.1
Migration from 1.20.x to 1.21.0
Migration from 1.19.x to 1.20.x
Migration from 1.14.x to 1.20.x
Migration from 1.16.x to 1.19.x
Migration from 1.14.x to 1.16.x
Migration from 1.13.x to 1.14.x

1.21.0 to 1.21.1

All necessary Sensibill dependencies are now included in sensibill-sdk-all. You may need to remove other Sensibill dependencies from your build.gradle file when migrating to this and future versions.

1.20.x to 1.21.0

No interface changes between 1.20.x to 1.21.x

1.19.x to 1.20.x

No interface changes between 1.19.x to 1.20.x

1.14.x to 1.20.x

1.16.x to 1.19.x

No interface changes between 1.16.x to 1.19.x

1.14.x to 1.16.x

Build Dependency Changes

Compile SDK version: 28
Target SDK version: 28
Build Tools version: 28.0.3
Android Support Library version: 28.0.0
Android Gradle Tool version: 3.2.0

Package / Class Name Change

1.14.x	1.16.x
com.getsensibill.oauthclient.OauthUser	com.getsensibill.oauthclient.OauthSession

Deprecated Function

Deprecated function	Reason
InitializationBuilder.transactionDataObserver	Transaction Data Observer is no longer added to the InitializationBuilder. Added to SensibillSDK directly (SensibillSDK.addTransactionDataObserver())
InitializationBuilder.receiptDataObserver	Receipt Data Observer is no longer added to the InitializationBuilder. Added to SensibillSDK directly (SensibillSDK.addReceiptDataObserver())

Notes for Migration

Function to add TransactionObserver and ReceiptDataObserver moved to SensibillSDK object from InitializationBuilder
The above must be done after initialization
Example:

before:

        // Create Observers
        myTransactionDataObserver = MyTransactionDataObserver()
        myReceiptDataObserver = MyReceiptDataObserver()

        // Add to initializer
        initializationBuilder.transactionDataObserver(myTransactionDataObserver)
        initializationBuilder.receiptDataObserver(myReceiptDataObserver)

        // Initialize
        mInitializer = initializationBuilder.build()
        SensibillSDK.getInstance().initialize(mInitializer)

after:

        // Create Observers
        myTransactionDataObserver = MyTransactionDataObserver()
        myReceiptDataObserver = MyReceiptDataObserver()

        // Initialize
        SensibillSDK.getInstance().initialize(mInitializer)

        // Add to SDK
        SensibillSDK.addTransactionDataObserver(myTransactionDataObserver)
        SensibillSDK.addReceiptDataObserver(myReceiptDataObserver)

It is also possible now to remove the observers by calling:

SensibillSDK.removeTransactionDataObserver(myTransactionDataObserver)
SensibillSDK.removeReceiptDataObserver(myReceiptDataObserver)

1.13.x to 1.14.x

Feature Added

ReceiptCaptureActivityBuilder used to create intent for ReceiptCapture

Function Name Change

Old Function Name	New Function Name
OAuthSettings.getApikey()	OAuthSettings.getApiKey()
SensibillSDK.getInstance()	SensibillSDK.INSTANCE (in Java)

Package / Class Name Change

Migration to core module

1.13.x	1.14.x
com.getsensibill.sensibillsdk.interfaces.OnTrackEventListener	com.getsensibill.core.analytic.OnTrackEventListener
com.getsensibill.sensibillsdk.tracker.events.AnalyticsEvent	com.getsensibill.core.analytic.OnTrackEventListener
com.getsensibill.sensibillsdk.utilities.base.ActivityLifecycleListener	com.getsensibill.core.ActivityLifecycleListener
com.getsensibill.sensibillsdk.interfaces.TokenProvider	com.getsensibill.tokenprovider.TokenProvider
com.getsensibill.sensibillsdk.utilities.Transaction	com.getsensibill.core.analytic.Transaction
com.getsensibill.sensibillsdk.utilities.TransactionDataObserver	com.getsensibill.core.TransactionDataObserver
com.getsensibill.sensibillsdk.InitializationBuilder	com.getsensibill.core.InitializationBuilder
com.getsensibill.sensibillsdk.Initializer	com.getsensibill.core.Initializer
com.getsensibill.sensibillsdk.SensibillSDK	com.getsensibill.core.SensibillSDK
com.getsensibill.sensibillsdk.interfaces.LoginError	com.getsensibill.core.LoginError
com.getsensibill.sensibillsdk.interfaces.SDKStartup	com.getsensibill.core.SDKStartup

Migration to UI module

1.13.x	1.14.x
com.getsensibill.sensibillsdk.SBMainTabsFragment	com.getsensibill.ui.SBMainTabsFragment
com.getsensibill.sensibillsdk.receipt.capture.ReceiptCaptureActivity	com.getsensibill.ui.receipt.capture.ReceiptCaptureActivity
com.getsensibill.sensibillsdk.receipt.controllers.detail.ReceiptDetailActivity	com.getsensibill.ui.receipt.controllers.detail.ReceiptDetailActivity
com.getsensibill.sensibillsdk.receipt.controllers.detail.ReceiptDetailActivity	com.getsensibill.ui.receipt.controllers.detail.ReceiptDetailActivity

Deprecated Function

SensibillSDK.isInitialized() - removed, now use SensibillSDK.state() to check state of SDK. Check migration notes for details

SensibillSDK.login() - removed, replaced to use SensibillSDK.start(). Check migration notes for details

Notes for migration

Update Package Names

many of the non-ui classes under com.getsensibill.sensibillsdk are now under com.getsensibill.core
token provider is now separate module: com.getsensibill.tokenprovider
getNewAuthToken() has new implementation. From synchronous to async
SessionListener under sensibillAuth module
UI elements now under getsensibill.ui

SensibillSDK object

SensibillSDK functions can be called directly. No more .getInstance()
in Java, still call .INSTANCE

SensibillSDK.verifyToken removed

In sensibill-client to be released in -> “com.getsensibill:sensibill-client:1.14.8”

SensibillSDK.login(accessToken, username, cb) -> ‌SensibillSDK.start(username, cb)

No access token passed on start, uses provided token provider to get access token on start.

SensibillAuth.startLibrary()

Not available anymore
Authentication is not a wrapper of SDK
Must check if SensibillSDK is initialized

Authentication

Was renamed to SensibillAuth
SensibillAuthBuilder was renamed to AuthenticationBuilder

TokenProvider is the only way to Initialization

Must use Authentication object if no custom TokenProvider.
For the SensibillSDK interface, one can call functions directly. No more .getInstance() (in Java, still call .INSTANCE)
SensibillAuth.startLibrary() is not available anymore. SensibillSDK.start() is used instead. But before, check if SensibillSDK is already initialized.

before:

     mSensibillAuth.startLibrary(mInitializer, username, listener)

after:

     if (SensibillSDK.getState() == CoreState.INITIALIZED) {
         SensibillSDK.start(username, listener)
     }

SensibillSDK.login(accessToken, username, cb) is also not needed anymore, ‌SensibillSDK.start(username, cb) will be enough. Since now token provider is added on the initialization, there is no need for a separate method to start with token. And token provider will give access token during on start process.