Package com.clover.sdk.v3.payments.api
Class SelectReceiptRequestIntentBuilder
- java.lang.Object
-
- com.clover.sdk.v3.payments.api.BaseIntentBuilder
-
- com.clover.sdk.v3.payments.api.SelectReceiptRequestIntentBuilder
-
public class SelectReceiptRequestIntentBuilder extends BaseIntentBuilder
Use the ReceiptSelectionRequestIntentBuilder class to initiate a receipt selection activity, for the merchant. It currently support payment, credits and refund receipts. It can also be used to configure specific options for receipt selection such as hiding or showing options or specifying if a default Clover receipt should be sent.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SelectReceiptRequestIntentBuilder.EmailReceiptOption
EmailReceiptOption that allows the Integrator to control the Email receipt option.static class
SelectReceiptRequestIntentBuilder.NoReceiptOption
PrintReceiptOption that allows the Integrator to control the Print receipt option.static class
SelectReceiptRequestIntentBuilder.PrintReceiptOption
PrintReceiptOption that allows the Integrator to control the Print receipt option.static class
SelectReceiptRequestIntentBuilder.ReceiptOption
Base class for specific receipt optionsstatic class
SelectReceiptRequestIntentBuilder.SmsReceiptOption
Options for Sms/Text receipts option
-
Field Summary
-
Fields inherited from class com.clover.sdk.v3.payments.api.BaseIntentBuilder
PAPI_SDK_NAME
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Intent
build(Context context)
Creates a single use intent to start the receipt selection screen ActivitySelectReceiptRequestIntentBuilder
cloverShouldHandleReceipts(Boolean cloverShouldHandleReceipts)
If true, default Clover receipts will be processed using Clover's default receipt processing.static SelectReceiptRequestIntentBuilder
Credit(String creditId)
Used to create a Credit/Manual Refund receipt request to launch the Receipt Selection ActivitySelectReceiptRequestIntentBuilder
emailReceiptOptions(SelectReceiptRequestIntentBuilder.EmailReceiptOption receiptOptions)
Set Email receipt options for the Select Receipt Activity, including enabled/disabled and a pre-populated email addressSelectReceiptRequestIntentBuilder
noReceiptReceiptOptions(SelectReceiptRequestIntentBuilder.NoReceiptOption receiptOptions)
Set No Receipt, receipt options for the Select Receipt Activity, including enabled/disabled note: this will only have an effect on customer facing screensstatic SelectReceiptRequestIntentBuilder
Payment(String paymentId)
Used to create a Payment receipt request to launch the Receipt Selection ActivitySelectReceiptRequestIntentBuilder
printReceiptOptions(SelectReceiptRequestIntentBuilder.PrintReceiptOption receiptOptions)
Set Print receipt options for the Select Receipt Activity, including enabled/disabledstatic SelectReceiptRequestIntentBuilder
Refund(String refundId)
Used to create a payment Refund receipt request to launch the Receipt Selection ActivitySelectReceiptRequestIntentBuilder
smsReceiptOptions(SelectReceiptRequestIntentBuilder.SmsReceiptOption receiptOptions)
Set SMS receipt options for the Select Receipt Activity, including enabled/disabled and a pre-populated phone number
-
-
-
Method Detail
-
Payment
public static SelectReceiptRequestIntentBuilder Payment(String paymentId)
Used to create a Payment receipt request to launch the Receipt Selection Activity- Parameters:
paymentId
-- Returns:
-
Credit
public static SelectReceiptRequestIntentBuilder Credit(String creditId)
Used to create a Credit/Manual Refund receipt request to launch the Receipt Selection Activity- Parameters:
creditId
-- Returns:
-
Refund
public static SelectReceiptRequestIntentBuilder Refund(String refundId)
Used to create a payment Refund receipt request to launch the Receipt Selection Activity- Parameters:
refundId
-- Returns:
-
smsReceiptOptions
public SelectReceiptRequestIntentBuilder smsReceiptOptions(SelectReceiptRequestIntentBuilder.SmsReceiptOption receiptOptions)
Set SMS receipt options for the Select Receipt Activity, including enabled/disabled and a pre-populated phone number- Parameters:
receiptOptions
-- Returns:
-
emailReceiptOptions
public SelectReceiptRequestIntentBuilder emailReceiptOptions(SelectReceiptRequestIntentBuilder.EmailReceiptOption receiptOptions)
Set Email receipt options for the Select Receipt Activity, including enabled/disabled and a pre-populated email address- Parameters:
receiptOptions
-- Returns:
-
printReceiptOptions
public SelectReceiptRequestIntentBuilder printReceiptOptions(SelectReceiptRequestIntentBuilder.PrintReceiptOption receiptOptions)
Set Print receipt options for the Select Receipt Activity, including enabled/disabled- Parameters:
receiptOptions
-- Returns:
-
noReceiptReceiptOptions
public SelectReceiptRequestIntentBuilder noReceiptReceiptOptions(SelectReceiptRequestIntentBuilder.NoReceiptOption receiptOptions)
Set No Receipt, receipt options for the Select Receipt Activity, including enabled/disabled note: this will only have an effect on customer facing screens- Parameters:
receiptOptions
-- Returns:
-
cloverShouldHandleReceipts
public SelectReceiptRequestIntentBuilder cloverShouldHandleReceipts(Boolean cloverShouldHandleReceipts)
If true, default Clover receipts will be processed using Clover's default receipt processing. If false, no Clover receipts will be processed, but the selection (and sms/email if entered) will be returned so custom receipt handling can be used. by default, receipts will be processed using default Clover receipts- Parameters:
cloverShouldHandleReceipts
-- Returns:
-
build
public Intent build(Context context)
Creates a single use intent to start the receipt selection screen Activity- Overrides:
build
in classBaseIntentBuilder
- Parameters:
context
-- Returns:
-
-