|
| 1 | +# Installation |
| 2 | + |
| 3 | +## Requirements |
| 4 | + |
| 5 | +minSdkVersion = 21 |
| 6 | +compileSdkVersion = 29 |
| 7 | +java 8 |
| 8 | + |
| 9 | +androidx and a material components theme for ui components |
| 10 | + |
| 11 | +### Using the snabble GitHub Repository |
| 12 | + |
| 13 | +Add the snabble maven repository for out and the Datatrans SDK: |
| 14 | + |
| 15 | +``` groovy |
| 16 | +repositories { |
| 17 | + maven { |
| 18 | + url 'https://raw.githubusercontent.com/snabble/maven-repository/releases' |
| 19 | + } |
| 20 | +} |
| 21 | +``` |
| 22 | + |
| 23 | +Then add the library to your dependencies. |
| 24 | + |
| 25 | +``` groovy |
| 26 | +dependencies { |
| 27 | + // core library |
| 28 | + implementation 'io.snabble.sdk:core:{{ extra.sdk_version }}' |
| 29 | + |
| 30 | + // user interface library |
| 31 | + implementation 'io.snabble.sdk:ui:{{ extra.sdk_version }}' |
| 32 | + |
| 33 | + // user interface integration library, entirely optional, |
| 34 | + // for more seamless and easier integration in apps |
| 35 | + implementation 'io.snabble.sdk:ui-integration:{{ extra.sdk_version }}' |
| 36 | +} |
| 37 | +``` |
| 38 | + |
| 39 | +### Locally |
| 40 | + |
| 41 | +The library can be installed to the local maven repository using: |
| 42 | + |
| 43 | +``` sh |
| 44 | +./gradlew publishToMavenLocal |
| 45 | +``` |
| 46 | + |
| 47 | +Make sure you add maven local to your repositories in your gradle script. |
| 48 | + |
| 49 | +``` groovy |
| 50 | +repositories { |
| 51 | + mavenLocal() |
| 52 | +} |
| 53 | +``` |
| 54 | + |
| 55 | +Then add the library to your dependencies. (Note: The + means it always uses the latest version) |
| 56 | + |
| 57 | +``` groovy |
| 58 | +dependencies { |
| 59 | + implementation 'io.snabble.sdk:core:{{ extra.sdk_version }}' |
| 60 | + implementation 'io.snabble.sdk:ui:{{ extra.sdk_version }}' |
| 61 | + implementation 'io.snabble.sdk:ui-integration:{{ extra.sdk_version }}' |
| 62 | +} |
| 63 | +``` |
| 64 | + |
| 65 | +## Usage |
| 66 | +``` java |
| 67 | +//you may enable debug logging to see requests made by the sdk, and other various logs |
| 68 | +Snabble.setDebugLoggingEnabled(true); |
| 69 | + |
| 70 | +Snabble.Config config = new Snabble.Config(); |
| 71 | +config.appId = <your app id> |
| 72 | +config.secret = <your secret> |
| 73 | + |
| 74 | +// optional: provide a metadata file, store in the assets. That allows the sdk |
| 75 | +// init without requiring a network connection. |
| 76 | +config.bundledMetadataAssetPath = "metadata.json"; |
| 77 | + |
| 78 | +final Snabble snabble = Snabble.getInstance(); |
| 79 | +snabble.setup(this, config, new Snabble.SetupCompletionListener() { |
| 80 | + @Override |
| 81 | + public void onReady() { |
| 82 | + // get the first project, there can be multiple projects per app |
| 83 | + project = snabble.getProjects().get(0); |
| 84 | + |
| 85 | + // registers this project globally for use with ui components |
| 86 | + SnabbleUI.useProject(project); |
| 87 | + |
| 88 | + // select the first shop for demo purposes, ideally this should be done with |
| 89 | + // geofencing or a manual user selection |
| 90 | + if (project.getShops().length > 0) { |
| 91 | + project.getCheckout().setShop(project.getShops()[0]); |
| 92 | + } |
| 93 | + |
| 94 | + // optional: set a loyalty card id for identification, for demo purposes |
| 95 | + // we invent one here |
| 96 | + project.setLoyaltyCardId("testAppUserLoyaltyCardId"); |
| 97 | + |
| 98 | + // optional: load a bundled database file from the assets folder |
| 99 | + // this lowers the download size of database updates and the database is immediatly |
| 100 | + // available offline |
| 101 | + project.getProductDatabase().loadDatabaseBundle("db.sqlite3", revision, major, minor); |
| 102 | + |
| 103 | + // recommended: download the latest product database for offline availability |
| 104 | + // it is highly recommended to call this in shorter time frames than config.maxProductDatabaseAge is set at |
| 105 | + // since the local database is only used if the time since the last update is smaller than |
| 106 | + // config.maxProductDatabaseAge, which defaults to 1 hour |
| 107 | + // |
| 108 | + // a good place for this is the onStart() method of your activity |
| 109 | + // database updates are usually very small since we are using delta updates for updating the database |
| 110 | + // |
| 111 | + // also a good place for database updates are background schedulers like |
| 112 | + // https://developer.android.com/topic/libraries/architecture/workmanager |
| 113 | + project.getProductDatabase().update(); |
| 114 | + } |
| 115 | + |
| 116 | + @Override |
| 117 | + public void onError(Snabble.Error error) { |
| 118 | + // connecton error if no metadata file is bundled or config error |
| 119 | + // if no appId or secret is provided |
| 120 | + } |
| 121 | +}); |
| 122 | +``` |
0 commit comments