core/io.snabble.sdk/Config

Config

data class Config(var endpointBaseUrl: String = Environment.PRODUCTION.baseUrl, var appId: String? = null, var secret: String? = null, var bundledMetadataAssetPath: String? = null, var bundledMetadataRawResId: Int = 0, var generateSearchIndex: Boolean = false, var maxProductDatabaseAge: Long = TimeUnit.HOURS.toMillis(1), var maxShoppingCartAge: Long = TimeUnit.HOURS.toMillis(4), var disableCertificatePinning: Boolean = false, var initialSQL: List<String> = emptyList(), var vibrateToConfirmCartFilled: Boolean = false, var loadActiveShops: Boolean = false, var checkInRadius: Float = 500.0f, var checkOutRadius: Float = 1000.0f, var lastSeenThreshold: Long = TimeUnit.MINUTES.toMillis(15), var networkInterceptor: Interceptor? = null, var manualProductDatabaseUpdates: Boolean = false)

Configuration of the snabble SDK.

Constructors

constructor(endpointBaseUrl: String = Environment.PRODUCTION.baseUrl, appId: String? = null, secret: String? = null, bundledMetadataAssetPath: String? = null, bundledMetadataRawResId: Int = 0, generateSearchIndex: Boolean = false, maxProductDatabaseAge: Long = TimeUnit.HOURS.toMillis(1), maxShoppingCartAge: Long = TimeUnit.HOURS.toMillis(4), disableCertificatePinning: Boolean = false, initialSQL: List<String> = emptyList(), vibrateToConfirmCartFilled: Boolean = false, loadActiveShops: Boolean = false, checkInRadius: Float = 500.0f, checkOutRadius: Float = 1000.0f, lastSeenThreshold: Long = TimeUnit.MINUTES.toMillis(15), networkInterceptor: Interceptor? = null, manualProductDatabaseUpdates: Boolean = false)

Types

object Companion

Properties

var appId: String?

The project identifier, which is used in the communication with the backend.

bundledMetadataAssetPath

var bundledMetadataAssetPath: String?

Relative path from the assets folder which points to a bundled file which contains the metadata.

bundledMetadataRawResId

var bundledMetadataRawResId: Int

Resource id of the raw file which contains the metadata.

var checkInRadius: Float

The radius in which the CheckInManager tries to check in a shop.

var checkOutRadius: Float

The radius in which the CheckInManager tries to stay in a shop, if already in it. If outside of this radius and the lastSeenThreshold, you will be checked out.

disableCertificatePinning

var disableCertificatePinning: Boolean

If set to true, disables certificate pinning. Not recommended for production!

endpointBaseUrl

var endpointBaseUrl: String

The endpoint url of the snabble backend. For example "https://api.snabble.io" for the Production environment.

generateSearchIndex

var generateSearchIndex: Boolean

If set to true, creates an full text index to support searching in the product database using findByName or searchByName.

var initialSQL: List<String>

SQL queries that will get executed in order on the product database.

lastSeenThreshold

var lastSeenThreshold: Long

The time in milliseconds which we keep you checked in at a shop.

loadActiveShops

var loadActiveShops: Boolean

Set to true, to load shops that are marked as pre launch and are not part of the original metadata in the backend (for example for testing shops in production before a go-live)

manualProductDatabaseUpdates

var manualProductDatabaseUpdates: Boolean

Set to true if you want to control when the product database gets updated, otherwise the product database gets updated when checking in and if checked in when the app resumes

maxProductDatabaseAge

var maxProductDatabaseAge: Long

The time that the database is allowed to be out of date. After the specified time in milliseconds the database only uses online requests for asynchronous requests.

maxShoppingCartAge

var maxShoppingCartAge: Long

The time that the shopping cart is allowed to be alive after the last modification.

networkInterceptor

var networkInterceptor: Interceptor?

Network interceptor used for all calls made by the SDK.

var secret: String?

The secret needed for Totp token generation

vibrateToConfirmCartFilled

var vibrateToConfirmCartFilled: Boolean

Vibrate while adding a product to the cart, by default false.

Functions

fun save(context: Context)