sdk/com.fairmatic.sdk.classes

Package-level declarations

Types

class FairmaticConfiguration(var sdkKey: String, val driverId: String, val fairmaticDriverAttributes: FairmaticDriverAttributes)

The configuration to pass to Fairmatic for com.fairmatic.sdk.Fairmatic.setup. It contains properties like the sdk key, driver id, driver attributes etc.

FairmaticDriverAttributes

class FairmaticDriverAttributes(var firstName: String, var lastName: String, var email: String? = null, var phoneNumber: String? = null)

Additional attributes of a Leeo driver. The application can specify both predefined and custom attributes for a driver. These attributes are associated with a SDK driverId at SDK initialization time. In addition to predefined special attributes, up to 4 custom key value attributes can be associated with a driver of the Leeo SDK. These attributes are available on the Fairmatic dashboard and via the API.

FairmaticErrorCode

enum FairmaticErrorCode : Enum<FairmaticErrorCode>

An error code that indicates the type of error that occurred during a Fairmatic SDK operation.

FairmaticOperationCallback

interface FairmaticOperationCallback

Callback that is used for asynchronous Fairmatic calls. It is invoked upon completion of the call. The callback is made on main thread.

FairmaticOperationResult

sealed interface FairmaticOperationResult

A result of an operation performed on the Leeo SDK. This indicates whether the operation was a success or a failure. In the case of failure, a error code and error message are provided.

FairmaticSettingError

enum FairmaticSettingError : Enum<FairmaticSettingError>

List of errors that must be resolved for trip detection to work correctly.

FairmaticSettingsCallback

interface FairmaticSettingsCallback

The callback returned to the application as a result of a call to com.fairmatic.sdk.Fairmatic.getFairmaticSettings. Callback is made on the Main Thread.

FairmaticTripNotification

class FairmaticTripNotification(val title: String, val content: String, @DrawableRes val iconId: Int)

Used to encapsulate a notification along with a notification ID.

TripNotificationContainer

data class TripNotificationContainer(val channel: NotificationChannel, val notification: Notification, val notificationId: Int)

This class is used to bundle together all the necessary components for displaying a trip-related notification.

TripNotificationContainerProvider

fun interface TripNotificationContainerProvider

Functional interface for providing TripNotificationContainer instances. This interface allows for lazy evaluation of trip notifications and helps prevent memory leaks by avoiding direct references to contexts in lambda expressions.