com.squareup.sdk.reader.checkout

Class TipSettings.Builder

java.lang.Object

com.squareup.sdk.reader.checkout.TipSettings.Builder

Enclosing class:

TipSettings

public static final class TipSettings.Builder
extends java.lang.Object

Builder class for constructing TipSettings objects.

Method Summary

Modifier and Type	Method and Description
TipSettings	build() Creates a new immutable TipSettings object, copying the attributes from this builder.
TipSettings.Builder	showCustomTipField(boolean showCustomTipField) Indicates whether custom tip amounts are allowed during the checkout flow.
TipSettings.Builder	showSeparateTipScreen(boolean showSeparateTipScreen) Indicates whether tip options should be presented on their own screen before presenting the signature screen during credit card transactions.
TipSettings.Builder	tipPercentages(int... tipPercentages) A list of tip percentages that should be presented during the checkout flow.
TipSettings.Builder	tipPercentages(java.util.List<java.lang.Integer> tipPercentages)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

showCustomTipField

@NonNull
public TipSettings.Builder showCustomTipField(boolean showCustomTipField)

Indicates whether custom tip amounts are allowed during the checkout flow.

Defaults to disabled.

Parameters:

showCustomTipField - true to allow custom tip amounts, false otherwise.

Returns:

This builder.

showSeparateTipScreen

@NonNull
public TipSettings.Builder showSeparateTipScreen(boolean showSeparateTipScreen)

Indicates whether tip options should be presented on their own screen before presenting the signature screen during credit card transactions.

Defaults to true.

Parameters:

showSeparateTipScreen - true to show tip options on a separate screen, false otherwise.

Returns:

This builder.

tipPercentages

@NonNull
public TipSettings.Builder tipPercentages(@NonNull
                                                   int... tipPercentages)

A list of tip percentages that should be presented during the checkout flow. Specified as up to 3 positive integers from 1 to 100 (inclusive).

Defaults to [15, 20, 25], which corresponds to tip percentages of 15%, 20%, and 25%.

Parameters:

tipPercentages - Custom tip percentages.

Returns:

This builder.

tipPercentages

@NonNull
public TipSettings.Builder tipPercentages(@NonNull
                                                   java.util.List<java.lang.Integer> tipPercentages)

See Also:

tipPercentages(int...)

build

@NonNull
public TipSettings build()

Creates a new immutable TipSettings object, copying the attributes from this builder.