core/io.snabble.sdk

Package-level declarations

Types

open class AccessibleLiveData<T> : LiveData<T>

LiveData with the current (possible not yet published) value. You can observe changes like with regular LiveData. You can write from any thread the value it will be posted on the main thread and published there when called from a background thread.

Assets

open class Assets

Class for accessing image assets from the snabble backend.

BarcodeFormat

enum BarcodeFormat : Enum<BarcodeFormat>

Enum describing a barcode format

Brand

data class Brand(val id: String, val name: String) : Comparable<Brand>

ColorUtils

object ColorUtils

Company

data class Company(val city: String?, val country: String?, val name: String?, val street: String?, val zip: String?)

Class describing a company

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.

CustomerCardInfo

data class CustomerCardInfo(val cardId: String, val isRequired: Boolean)

Class describing customer cards

Dimension

enum Dimension : Enum<Dimension>

Enum describing a group of units

Environment

enum Environment : Enum<Environment>

Enum describing the environment the app is using

FulfillmentState

enum FulfillmentState : Enum<FulfillmentState>

Enum class describing the state of a fulfillment

InitializationState

enum InitializationState : Enum<InitializationState>

Enum class describing the current initialization state of the SDK

InterceptorSerializer

object InterceptorSerializer : JsonSerializer<Interceptor?> , JsonDeserializer<Interceptor?>

Link

data class Link(val href: String)

Data class for a link

MutableAccessibleLiveData

class MutableAccessibleLiveData<T> : AccessibleLiveData<T>

Mutable LiveData with the current (possible not yet published) value. You can observe changes like with regular MutableLiveData, just not inherited. You can write from any thread the value it will be posted on the main thread and published there when called from a background thread.

OnProductAvailableListener

interface OnProductAvailableListener

Interface for product api calls

PaymentMethod

enum PaymentMethod : Enum<PaymentMethod> , Parcelable

Enum class describing payment methods

PaymentMethodDescriptor

data class PaymentMethodDescriptor(val id: String, val links: Map<String, Link>?, val providerName: String, val acceptedOriginTypes: List<String>?)

A class describing a payment method

PriceFormatter

class PriceFormatter(project: Project)

A price formatter for formatting prices using the provided currency information

Product

open class Product : Serializable, Parcelable

Class that holds all of the product information.

ProductDatabase

open class ProductDatabase

Class for interfacing with the local product database

Project

class Project

A project contains configuration information and backend api urls needed for a retailer.

ReceiptInfo

data class ReceiptInfo(val id: String, val projectId: String, val timestamp: Long, val pdfUrl: String?, val shopName: String, val price: String)

Class containing information about a order

Receipts

class Receipts

Class to download user receipts in pdf format to internal storage.

ReceiptsApi

open class ReceiptsApi

Class for interfacing with the snabble Receipts API

Shop

open class Shop : Serializable, Parcelable

Class representing a shop

ShoppingCart

open class ShoppingCart : Iterable<T>

Class representing the snabble shopping cart

ShoppingCartData

data class ShoppingCartData @JvmOverloads constructor(var id: String = UUID.randomUUID().toString(), var uuid: String? = UUID.randomUUID().toString(), var lastModificationTime: Long = 0, var items: MutableList<ShoppingCart.Item> = mutableListOf(), var violationNotifications: MutableList<ViolationNotification> = mutableListOf(), var modCount: Int = 0, var addCount: Int = 0, var onlineTotalPrice: Int? = null, var invalidProducts: List<Product>? = null, var taxation: ShoppingCart.Taxation = ShoppingCart.Taxation.UNDECIDED, var hasRaisedMaxCheckoutLimit: Boolean = false, var hasRaisedMaxOnlinePaymentLimit: Boolean = false, var invalidDepositReturnVoucher: Boolean = false, var backupTimestamp: Long = 0)

Snabble

object Snabble

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

SnabbleFileProvider

open class SnabbleFileProvider : FileProvider

Tagging subclass to avoid clashes with misbehaving libraries

SnabbleInitializer

class SnabbleInitializer : Initializer<Snabble>

Initializer for the snabble SDK using androidx.startup

TermsOfService