core/io.snabble.sdk/Snabble

Snabble

object Snabble

The heart of the snabble SDK. Initialization and object access is provided via this facade.

Types

enum Error : Enum<Snabble.Error>

Enum describing the error types, which can occur during initialization of the SDK

OnMetadataUpdateListener

fun interface OnMetadataUpdateListener

Interface for notifying when our metadata is getting updated

SnabbleException

class SnabbleException : Exception

Exception used for SDK initialization errors

Properties

additionalMetadata

val additionalMetadata: JsonObject?

Returns additional metadata that may be provided for apps unrelated to the SDK

lateinit var application: Application

The main Android application

lateinit var brands: Map<String, Brand>

Map of available brands

checkedInProject

var checkedInProject: MutableAccessibleLiveData<Project?>

The current checked in project.

var checkedInShop: Shop?

Sets the shop used for receiving store specific prices and identification in the payment process

checkInLocationManager

lateinit var checkInLocationManager: CheckInLocationManager

Location manager for use with the check in manager

lateinit var checkInManager: CheckInManager

Geo-fencing based check in manager. Use for automatically detecting if you are in a shop.

val clientId: String?

Unique identifier, different over device installations

lateinit var config: Config

The config provided after calling Snabble.setup

var consentUrl: String?

Url to retrieve consent status of the user

createAppUserUrl

var createAppUserUrl: String?

Url to create a new app user

currentActivity

var currentActivity: WeakReference<Activity>?

Weak reference to the current activity

currentCheckedInShop

var currentCheckedInShop: LiveData<Shop?>

Get the current checked in shop as a live data.

customProperties

val customProperties: MutableMap<Pair<CustomProperty, ProjectId>, Any>

Set CustomProperty's to override the default behavior.

endpointBaseUrl

val endpointBaseUrl: String

The current endpoint base url used by the SDK

var environment: Environment?

The environment the SDK is using.

var error: Snabble.Error?

Get the error during initialization of the SDK occurred

formPrefillData

var formPrefillData: FormPrefillData?

Set to have PAYONE forms prefilled with the given data.

var giropayAuthUrl: String?

Url for generating payone web form authentication challenges

initializationState

val initializationState: LiveData<InitializationState>

The current initialization state of the SDK. Fragments observe this state and only if the SDK is initialized will get displayed to the user.

val instance: Snabble

Retrieve the global instance of snabble.

internalStorageDirectory

lateinit var internalStorageDirectory: File

The internal storage directory in which snabble stores files

var isMergeable: IsMergeable?

Set to take control over ShoppingCart.Item.isMergeable default behavior.

val isOutdatedSDK: Boolean

Returns true when the SDK is not compatible with the backend anymore and the app should notify the user that it will not function anymore.

var metadataUrl: String?

The url where all the properties come from

lateinit var okHttpClient: OkHttpClient

OkHttpClient for general use.

paymentCertificates

var paymentCertificates: List<X509Certificate>?

List of certificates to match against user encrypted payment certificates. If those are not valid anymore, our backend is not able to decode the encrypted payment credentials anymore.

paymentCredentialsStore

lateinit var paymentCredentialsStore: PaymentCredentialsStore

Add and retrieve local encrypted payment credentials

lateinit var projects: List<Project>

The list of available projects.

lateinit var receipts: Receipts

API-Wrapper to retrieve receipts

var receiptsUrl: String?

Url to retrieve receipts of the app user

telecashPreAuthUrl

var telecashPreAuthUrl: String?

Url for generating telecash web form authentication challenges

telecashSecretUrl

var telecashSecretUrl: String?

Url for generating telecash web form authentication challenges

var termsOfService: TermsOfService?

Retrieve the link for our terms of service

lateinit var tokenRegistry: TokenRegistry

Registry to retrieve and generate access tokens for backend api access

userPreferences

lateinit var userPreferences: UserPreferences

Local persisted user preferences

lateinit var users: Users

Access to user specific information, e.g. User-Consent / Unique-ID

var usersUrl: String?

Url to retrieve user related information

val version: String

The version of the SDK

var versionName: String?

snabble SDK version name

Functions

fun absoluteUrl(url: String): String

Converts a relative url to a absolute url, depending on the environment.

addOnMetadataUpdateListener

fun addOnMetadataUpdateListener(onMetaDataUpdateListener: Snabble.OnMetadataUpdateListener)

Adds a listener that gets called every time the metadata updates

fun getProjectById(projectId: String?): Project?

Finds a project by it's id

removeOnMetadataUpdateListener

fun removeOnMetadataUpdateListener(onMetaDataUpdateListener: Snabble.OnMetadataUpdateListener)

Removes an already added listener

setDebugLoggingEnabled

fun setDebugLoggingEnabled(enabled: Boolean)

Enables debug logging

fun setup(app: Application? = null, config: Config? = null)

Setup the snabble SDK.

fun setupBlocking(app: Application, config: Config? = null)

The blocking version of .setup