toro/services.cabcard.toro.core.model/GratuityConfig

GratuityConfig

data class GratuityConfig @JvmOverloads constructor(val mode: GratuityMode = GratuityMode.NONE, val amounts: List<Int> = emptyList(), val percentages: List<Int> = emptyList(), val addGratuityPrompt: String = "Add Gratuity?", val header: String = "Select Tip")

Constructors

GratuityConfig

@JvmOverloads

constructor(mode: GratuityMode = GratuityMode.NONE, amounts: List<Int> = emptyList(), percentages: List<Int> = emptyList(), addGratuityPrompt: String = "Add Gratuity?", header: String = "Select Tip")

Properties

addGratuityPrompt

val addGratuityPrompt: String

Text shown on the yes/no prompt asking the cardholder if they want to add a gratuity. Used in GratuityMode.STANDARD and GratuityMode.CONFIGURED modes. Maximum 30 characters; an IllegalArgumentException will be thrown if exceeded.

amounts

val amounts: List<Int>

Fixed tip amounts in pence, displayed as selectable options in GratuityMode.CONFIGURED mode. E.g. listOf(100, 200, 300) renders as £1.00, £2.00, £3.00. Not applicable in GratuityMode.STANDARD mode — an IllegalArgumentException will be thrown. Maximum 3 amounts; an IllegalArgumentException will be thrown if exceeded. All values must not be negative; an IllegalArgumentException will be thrown otherwise.

header

val header: String

Header text shown at the top of the tipping selection menu. Used in GratuityMode.STANDARD and GratuityMode.CONFIGURED modes. Maximum 30 characters; an IllegalArgumentException will be thrown if exceeded.

mode

val mode: GratuityMode

The tipping mode to use.

percentages

val percentages: List<Int>

Tip percentages to display as selectable options. Only used in GratuityMode.CONFIGURED mode. In GratuityMode.STANDARD mode, percentages are fixed at 10%, 15%, and 20% — specifying custom percentages will throw an IllegalArgumentException. Maximum 3 percentages; an IllegalArgumentException will be thrown if exceeded. All values must be between 1 and 100; an IllegalArgumentException will be thrown otherwise.