Skip navigation links
A B C D E F G H I L M N O P R S T V 

A

addAuthorizeCallback(AuthorizeCallback) - Method in interface com.squareup.sdk.reader.authorization.AuthorizationManager
Adds a callback to handle the result of an authorization attempt.
addCheckoutActivityCallback(CheckoutActivityCallback) - Method in interface com.squareup.sdk.reader.checkout.CheckoutManager
Adds a callback to handle the result of the checkout flow.
addDeauthorizeCallback(DeauthorizeCallback) - Method in interface com.squareup.sdk.reader.authorization.AuthorizationManager
Adds a callback that handles the result of a deauthorization attempt.
AdditionalPaymentType - Enum in com.squareup.sdk.reader.checkout
The payment types an application may accept during checkout in addition to payments via Square Readers.
additionalPaymentTypes(Set<AdditionalPaymentType>) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
A set of payment types the application may accept during checkout in addition to payments via Square Readers, e.g.
additionalPaymentTypes(AdditionalPaymentType...) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
 
addReaderSettingsActivityCallback(ReaderSettingsActivityCallback) - Method in interface com.squareup.sdk.reader.hardware.ReaderManager
Adds a callback to handle the result of the reader settings flow.
addStoreCardActivityCallback(StoreCardActivityCallback) - Method in interface com.squareup.sdk.reader.crm.CustomerCardManager
Adds a callback to handle results from calls to CustomerCardManager.startStoreCardActivity(Context, String).
addTender(Tender) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 
allowSplitTender(boolean) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Indicates that the transaction may be split into multiple tenders during checkout.
alwaysRequireSignature(boolean) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Deprecated.
This is deprecated, and has no effect. See CheckoutParameters.Builder.collectSignature(boolean) instead.
amountMoney(Money) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
 
AuthorizationManager - Interface in com.squareup.sdk.reader.authorization
Lets the application authorize and deauthorize Reader SDK to collect payments on behalf of a Square location.
authorizationManager() - Static method in class com.squareup.sdk.reader.ReaderSdk
Returns the AuthorizationManager singleton for authorizing Reader SDK to collect payments.
AuthorizationState - Class in com.squareup.sdk.reader.authorization
An immutable snapshot of the authorization state of Reader SDK.
authorize(String) - Method in interface com.squareup.sdk.reader.authorization.AuthorizationManager
Asynchronously authorizes Reader SDK with a mobile authorization code.
AuthorizeCallback - Interface in com.squareup.sdk.reader.authorization
A callback that handles the result of an authorization attempt.
AuthorizeErrorCode - Enum in com.squareup.sdk.reader.authorization
Possible error codes that can be returned as a result of a call to AuthorizationManager.authorize(String).

B

build() - Method in class com.squareup.sdk.reader.authorization.Location.Builder
Creates a Location from the current state of this builder.
build() - Method in class com.squareup.sdk.reader.checkout.Card.Builder
 
build() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Constructs a CheckoutParameters from the current state of this builder.
build() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
Creates an immutable CheckoutResult object, copying the attributes from this builder.
build() - Method in class com.squareup.sdk.reader.checkout.Tender.Builder
Creates an immutable Tender object, copying the attributes from this builder.
build() - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails.Builder
Creates an immutable TenderCardDetails object, copying the attributes from this builder.
build() - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails.Builder
Creates a new immutable TenderCashDetails object, copying the attributes from this builder.
build() - Method in class com.squareup.sdk.reader.checkout.TipSettings.Builder
Creates a new immutable TipSettings object, copying the attributes from this builder.
buildUpon() - Method in class com.squareup.sdk.reader.authorization.Location
Creates a new Location Location.Builder, with attributes copied from this instance.
buildUpon() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
Creates a new CheckoutParameters CheckoutParameters.Builder, with attributes copied from this instance.
buildUpon() - Method in class com.squareup.sdk.reader.checkout.Tender
Creates a new Tender Tender.Builder, with attributes copied from this instance.
buildUpon() - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails
Creates a new TenderCardDetails TenderCardDetails.Builder, with attributes copied from this instance.
buildUpon() - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails
Creates a new TenderCashDetails TenderCashDetails.Builder, with attributes copied from this instance.
buildUpon() - Method in class com.squareup.sdk.reader.checkout.TipSettings
Creates a new TipSettings TipSettings.Builder, with attributes copied from this instance.
businessName(String) - Method in class com.squareup.sdk.reader.authorization.Location.Builder
 
buyerTenderedMoney(Money) - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails.Builder
 

C

Callback<R> - Interface in com.squareup.sdk.reader.core
Communicates the result of an asynchronous operation.
CallbackReference - Interface in com.squareup.sdk.reader.core
A reference to a Reader SDK Callback that can be cleared to prevent memory leaks.
canDeauthorize() - Method in class com.squareup.sdk.reader.authorization.AuthorizationState
Deauthorization fails if there are asynchronous payments recorded on the device that have not been uploaded to Square servers.
Card - Class in com.squareup.sdk.reader.checkout
Represents the non-confidential details of a card.
Card(Card.Brand, String) - Constructor for class com.squareup.sdk.reader.checkout.Card
Creates a new Card object for testing purposes.
card(Card) - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails.Builder
 
Card.Brand - Enum in com.squareup.sdk.reader.checkout
The brand (for example, VISA) of a Card.
Card.Builder - Class in com.squareup.sdk.reader.checkout
Lets developers create and configure card data for automated testing.
cardholderName(String) - Method in class com.squareup.sdk.reader.checkout.Card.Builder
 
cardProcessingActivated(boolean) - Method in class com.squareup.sdk.reader.authorization.Location.Builder
 
CardReceiptDetails - Class in com.squareup.sdk.reader.checkout
 
CardReceiptDetails(String, String, String) - Constructor for class com.squareup.sdk.reader.checkout.CardReceiptDetails
 
cardTender(String, TenderCardDetails) - Method in class com.squareup.sdk.reader.checkout.Tender.Builder
 
cashTender(TenderCashDetails) - Method in class com.squareup.sdk.reader.checkout.Tender.Builder
 
changeBackMoney(Money) - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails.Builder
 
CheckoutActivityCallback - Interface in com.squareup.sdk.reader.checkout
A callback that handles the result of a checkout activity.
CheckoutErrorCode - Enum in com.squareup.sdk.reader.checkout
Possible error codes that can be returned as a result of a call to CheckoutManager.startCheckoutActivity(Context, CheckoutParameters).
CheckoutManager - Interface in com.squareup.sdk.reader.checkout
Lets the application collect payment using Square's checkout flow.
checkoutManager() - Static method in class com.squareup.sdk.reader.ReaderSdk
Returns the CheckoutManager singleton for collecting payments using Square's checkout flow.
CheckoutParameters - Class in com.squareup.sdk.reader.checkout
CheckoutParameters.Builder - Class in com.squareup.sdk.reader.checkout
Builder class for constructing CheckoutParameters objects.
CheckoutResult - Class in com.squareup.sdk.reader.checkout
Represents the result of a transaction processed using the Reader SDK checkout flow.
CheckoutResult.Builder - Class in com.squareup.sdk.reader.checkout
Builder class for constructing CheckoutResult objects.
clear() - Method in interface com.squareup.sdk.reader.core.CallbackReference
Clears the reference to a Reader SDK Callback.
collectSignature(boolean) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Indicates that signature collection is required during checkout.
com.squareup.sdk.reader - package com.squareup.sdk.reader
Contains the entry point for Reader SDK.
com.squareup.sdk.reader.authorization - package com.squareup.sdk.reader.authorization
Contains classes to manage Reader SDK authentication.
com.squareup.sdk.reader.checkout - package com.squareup.sdk.reader.checkout
Contains classes to collect payment using Square's checkout flow.
com.squareup.sdk.reader.core - package com.squareup.sdk.reader.core
Contains Reader SDK utility classes.
com.squareup.sdk.reader.crm - package com.squareup.sdk.reader.crm
 
com.squareup.sdk.reader.hardware - package com.squareup.sdk.reader.hardware
Contains classes to connect and manage a set of Square Readers.
createdAt(Date) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 
createdAt(Date) - Method in class com.squareup.sdk.reader.checkout.Tender.Builder
 
currencyCode(CurrencyCode) - Method in class com.squareup.sdk.reader.authorization.Location.Builder
 
CurrencyCode - Enum in com.squareup.sdk.reader.checkout
Represents a currency.
current() - Static method in enum com.squareup.sdk.reader.checkout.CurrencyCode
The currency code of the most recently authorized location.
CustomerCardManager - Interface in com.squareup.sdk.reader.crm
Lets the application use a Square Reader to store card information for use in later transactions when the card may not be present (also known as storing a card "on file" for a customer to use).
customerCardManager() - Static method in class com.squareup.sdk.reader.ReaderSdk
Returns the CustomerCardManager singleton for tracking card-on-file information about customers.

D

deauthorize() - Method in interface com.squareup.sdk.reader.authorization.AuthorizationManager
Deauthorizes Reader SDK.
DeauthorizeCallback - Interface in com.squareup.sdk.reader.authorization
A callback that handles the result of a deauthorization attempt.
DeauthorizeErrorCode - Enum in com.squareup.sdk.reader.authorization
Possible error codes that can be returned as a result of a call to AuthorizationManager.deauthorize().
delayCapture(boolean) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
When true, if checkout completes successfully, the SDK will only authorize, but not capture any card payments.

E

entryMethod(TenderCardDetails.EntryMethod) - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails.Builder
 
entryMethod(CardReceiptDetails) - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails.Builder
 
equals(Object) - Method in class com.squareup.sdk.reader.authorization.AuthorizationState
 
equals(Object) - Method in class com.squareup.sdk.reader.authorization.Location
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.Card
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.CardReceiptDetails
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.Money
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.Tender
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails
 
equals(Object) - Method in class com.squareup.sdk.reader.checkout.TipSettings
 
equals(Object) - Method in class com.squareup.sdk.reader.core.Result
 
equals(Object) - Method in class com.squareup.sdk.reader.core.ResultError
 
ErrorCode - Interface in com.squareup.sdk.reader.core
Implemented by error code enums that are returned as a result of Reader SDK operations.
expirationMonth(int) - Method in class com.squareup.sdk.reader.checkout.Card.Builder
 
expirationYear(int) - Method in class com.squareup.sdk.reader.checkout.Card.Builder
 

F

format() - Method in class com.squareup.sdk.reader.checkout.Money
Calls Money.format(Locale) with the default locale.
format(Locale) - Method in class com.squareup.sdk.reader.checkout.Money
Formats this Money into a human-readable string, taking into account the associated currency and the provided Locale.

G

getAdditionalPaymentTypes() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
getAllowSplitTender() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
getAlwaysRequireSignature() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
getAmount() - Method in class com.squareup.sdk.reader.checkout.Money
The amount of money, in the smallest denomination of the specified currency.
getAmountMoney() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
getApplicationIdentifier() - Method in class com.squareup.sdk.reader.checkout.CardReceiptDetails
 
getApplicationPreferredName() - Method in class com.squareup.sdk.reader.checkout.CardReceiptDetails
 
getAuthorizationCode() - Method in class com.squareup.sdk.reader.checkout.CardReceiptDetails
 
getAuthorizationState() - Method in interface com.squareup.sdk.reader.authorization.AuthorizationManager
Returns an immutable snapshot of the current authorization state.
getAuthorizedLocation() - Method in class com.squareup.sdk.reader.authorization.AuthorizationState
Returns the currently authorized location.
getBrand() - Method in class com.squareup.sdk.reader.checkout.Card
The brand (for example, VISA) of this card.
getBusinessName() - Method in class com.squareup.sdk.reader.authorization.Location
The business name associated with the location.
getBuyerTenderedMoney() - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails
The total amount of cash provided to pay for the transaction, before change is given.
getCard() - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails
Details about the card used in this tender, including the brand and last four digits of the card number.
getCardDetails() - Method in class com.squareup.sdk.reader.checkout.Tender
Details related to the card payment represented by this tender.
getCardholderName() - Method in class com.squareup.sdk.reader.checkout.Card
The cardholder's full name.
getCardReceiptDetails() - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails
Details related to the card payment that can be used to produce EMV-compliant receipts.
getCashDetails() - Method in class com.squareup.sdk.reader.checkout.Tender
Details related to the cash payment represented by this tender.
getChangeBackMoney() - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails
The amount of cash returned during the transaction as change.
getCode() - Method in class com.squareup.sdk.reader.core.ResultError
Provides the error code.
getCollectSignature() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
Whether a signature should be collected as part of this transaction.
getCreatedAt() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
The date and time when the transaction was completed, as determined by the client device.
getCreatedAt() - Method in class com.squareup.sdk.reader.checkout.Tender
The date and time when the tender was created, as determined by the client device.
getCurrencyCode() - Method in class com.squareup.sdk.reader.authorization.Location
The currency used for all transactions at this location.
getCurrencyCode() - Method in class com.squareup.sdk.reader.checkout.Money
The currency code.
getDebugCode() - Method in class com.squareup.sdk.reader.core.ResultError
Provides a more detailed error code for troubleshooting.
getDebugMessage() - Method in class com.squareup.sdk.reader.core.ResultError
Provides a human-readable message containing additional debug information related to the possible cause of the error.
getDelayCapture() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
getEntryMethod() - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails
The method used to capture the card information at checkout.
getError() - Method in class com.squareup.sdk.reader.core.Result
The error, if the operation resulted in an error.
getExpirationMonth() - Method in class com.squareup.sdk.reader.checkout.Card
The year of the expiration month.
getExpirationYear() - Method in class com.squareup.sdk.reader.checkout.Card
The year of the expiration date.
getId() - Method in class com.squareup.sdk.reader.checkout.Card
The card identifier, if this card instance came from storing a card on file.
getLastFourDigits() - Method in class com.squareup.sdk.reader.checkout.Card
The last 4 digits of this card's number.
getLocationId() - Method in class com.squareup.sdk.reader.authorization.Location
The unique identifier for the location.
getLocationId() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
The unique ID of the location to which the transaction was credited.
getMaximumCardPaymentAmountMoney() - Method in class com.squareup.sdk.reader.authorization.Location
The maximum credit card payment amount for this location.
getMessage() - Method in class com.squareup.sdk.reader.core.ResultError
Provides a displayable message that summarizes the possible cause of the error.
getMinimumCardPaymentAmountMoney() - Method in class com.squareup.sdk.reader.authorization.Location
The minimum credit card payment amount for this location.
getName() - Method in class com.squareup.sdk.reader.authorization.Location
The name of the location (displayed as the location's nickname in Square Dashboard).
getNote() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
getShowCustomTipField() - Method in class com.squareup.sdk.reader.checkout.TipSettings
 
getShowSeparateTipScreen() - Method in class com.squareup.sdk.reader.checkout.TipSettings
 
getSkipReceipt() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
getSuccessValue() - Method in class com.squareup.sdk.reader.core.Result
The result of a successful operation.
getTenderId() - Method in class com.squareup.sdk.reader.checkout.Tender
A unique ID for this tender issued by Square's servers.
getTenders() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
The set of tenders associated with a successful transaction.
getTipMoney() - Method in class com.squareup.sdk.reader.checkout.Tender
The amount added to this tender as tip.
getTipPercentages() - Method in class com.squareup.sdk.reader.checkout.TipSettings
 
getTipSettings() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
getTotalMoney() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
The total amount collected during checkout.
getTotalMoney() - Method in class com.squareup.sdk.reader.checkout.Tender
The total amount of this tender, including tips.
getTotalTipMoney() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
The total tip amount applied to the transaction across all tenders and included as part of totalMoney.
getTransactionClientId() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
A unique client-generated ID for successful transactions.
getTransactionId() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
A unique ID issued by Square's servers for successful transactions that include one or more card tenders.
getType() - Method in class com.squareup.sdk.reader.checkout.Tender
The type of this tender.
getUsedDeprecatedAlwaysRequireSignature() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 

H

hashCode() - Method in class com.squareup.sdk.reader.authorization.AuthorizationState
 
hashCode() - Method in class com.squareup.sdk.reader.authorization.Location
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.Card
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.CardReceiptDetails
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.Money
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.Tender
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails
 
hashCode() - Method in class com.squareup.sdk.reader.checkout.TipSettings
 
hashCode() - Method in class com.squareup.sdk.reader.core.Result
 
hashCode() - Method in class com.squareup.sdk.reader.core.ResultError
 
hasSuccessValue() - Method in class com.squareup.sdk.reader.core.Result
Returns true if the operation was successful and the generic parameter S is not of type Void, false otherwise.

I

id(String) - Method in class com.squareup.sdk.reader.checkout.Card.Builder
 
initialize(Application) - Static method in class com.squareup.sdk.reader.ReaderSdk
Initializes the Square Reader SDK.
isAuthorizationInProgress() - Method in class com.squareup.sdk.reader.authorization.AuthorizationState
Returns true if a Reader SDK authorization is in progress, false otherwise.
isAuthorized() - Method in class com.squareup.sdk.reader.authorization.AuthorizationState
Returns true if Reader SDK is currently authorized to collect payments on behalf of a Square location, false otherwise.
isCardProcessingActivated() - Method in class com.squareup.sdk.reader.authorization.Location
Indicates whether or not this location is activated for credit card processing.
isError() - Method in class com.squareup.sdk.reader.core.Result
true if the operation resulted in an error.
isSuccess() - Method in class com.squareup.sdk.reader.core.Result
true if the operation was successful.
isUsageError() - Method in enum com.squareup.sdk.reader.authorization.AuthorizeErrorCode
 
isUsageError() - Method in enum com.squareup.sdk.reader.authorization.DeauthorizeErrorCode
 
isUsageError() - Method in enum com.squareup.sdk.reader.checkout.CheckoutErrorCode
 
isUsageError() - Method in interface com.squareup.sdk.reader.core.ErrorCode
Returns true if the error is a usage error, false otherwise.
isUsageError() - Method in enum com.squareup.sdk.reader.crm.StoreCustomerCardErrorCode
Tests whether the error code indicates an error in usage of Reader SDK.
isUsageError() - Method in enum com.squareup.sdk.reader.hardware.ReaderSettingsErrorCode
 

L

Location - Class in com.squareup.sdk.reader.authorization
Represents a currently authorized Square location.
Location.Builder - Class in com.squareup.sdk.reader.authorization
Builder class for constructing Location objects.
locationId(String) - Method in class com.squareup.sdk.reader.authorization.Location.Builder
 
locationId(String) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 

M

maximumCardPaymentAmountMoney(Money) - Method in class com.squareup.sdk.reader.authorization.Location.Builder
 
minimumCardPaymentAmountMoney(Money) - Method in class com.squareup.sdk.reader.authorization.Location.Builder
 
minus(Money) - Method in class com.squareup.sdk.reader.checkout.Money
Returns a new Money instance with the specified money amount subtracted from this money amount.
Money - Class in com.squareup.sdk.reader.checkout
Represents an amount of money.
Money(long, CurrencyCode) - Constructor for class com.squareup.sdk.reader.checkout.Money
Creates a new Money object.

N

name(String) - Method in class com.squareup.sdk.reader.authorization.Location.Builder
 
newAuthorizedState(Location, boolean) - Static method in class com.squareup.sdk.reader.authorization.AuthorizationState
Returns new authorized AuthorizationState instance.
newBuilder(String, CurrencyCode) - Static method in class com.squareup.sdk.reader.authorization.Location
Creates a new Location builder with default values.
newBuilder(Money) - Static method in class com.squareup.sdk.reader.checkout.CheckoutParameters
Creates a new CheckoutParameters builder with default values.
newBuilder(String, Money, String) - Static method in class com.squareup.sdk.reader.checkout.CheckoutResult
Creates a new CheckoutResult builder with default values.
newBuilder(Card, TenderCardDetails.EntryMethod, CardReceiptDetails) - Static method in class com.squareup.sdk.reader.checkout.TenderCardDetails
Creates a new TenderCardDetails builder with default values.
newBuilder(Money) - Static method in class com.squareup.sdk.reader.checkout.TenderCashDetails
Creates a new TenderCashDetails builder with default values.
newBuilder() - Static method in class com.squareup.sdk.reader.checkout.TipSettings
Creates a new TipSettings builder with default values.
newCardBuilder(Card.Brand, String) - Static method in class com.squareup.sdk.reader.checkout.Card
 
newCardTenderBuilder(String, Money, TenderCardDetails) - Static method in class com.squareup.sdk.reader.checkout.Tender
Creates a new tender builder of type Tender.Type.CARD with default values.
newCashTenderBuilder(Money, TenderCashDetails) - Static method in class com.squareup.sdk.reader.checkout.Tender
Creates a new tender builder of type Tender.Type.CASH with default values.
newError(E) - Static method in class com.squareup.sdk.reader.core.Result
Creates a new Result object representing an error.
newInProgressState() - Static method in class com.squareup.sdk.reader.authorization.AuthorizationState
Returns a new in progress AuthorizationState instance.
newOtherTenderBuilder(Money) - Static method in class com.squareup.sdk.reader.checkout.Tender
Creates a new tender builder of type Tender.Type.OTHER with default values.
newSuccess(S) - Static method in class com.squareup.sdk.reader.core.Result
Creates a new Result object representing a success with a success value.
newSuccess() - Static method in class com.squareup.sdk.reader.core.Result
Creates a new Result object representing a success without a success value.
newUnauthorizedState() - Static method in class com.squareup.sdk.reader.authorization.AuthorizationState
Returns a new unauthorized AuthorizationState instance.
noAdditionalPaymentTypes() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Clears the additionalPaymentTypes parameter.
noNote() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Clears the note parameter.
note(String) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
An optional note to associate with the transaction.
noTenders() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 
noTip() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Disables tipping.
noTransactionId() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 

O

onResult(R) - Method in interface com.squareup.sdk.reader.core.Callback
 
otherTender() - Method in class com.squareup.sdk.reader.checkout.Tender.Builder
 

P

plus(Money) - Method in class com.squareup.sdk.reader.checkout.Money
Returns a new money instance with the specified money amount added to this money amount.

R

ReaderManager - Interface in com.squareup.sdk.reader.hardware
Lets the application present screens for connecting and managing a set of Square Readers.
readerManager() - Static method in class com.squareup.sdk.reader.ReaderSdk
Returns the ReaderManager singleton for connecting and managing Square Card Readers.
ReaderSdk - Class in com.squareup.sdk.reader
The entry point for Reader SDK.
ReaderSettingsActivityCallback - Interface in com.squareup.sdk.reader.hardware
A callback that handles the result of a Square Reader settings activity.
ReaderSettingsErrorCode - Enum in com.squareup.sdk.reader.hardware
Possible error codes that can be returned as a result of a call to ReaderManager.startReaderSettingsActivity(Context).
Result<S,E> - Class in com.squareup.sdk.reader.core
The result of an asynchronous operation.
ResultError<C> - Class in com.squareup.sdk.reader.core
Represents an error when an operation was not successful.
ResultError(C, String, String, String) - Constructor for class com.squareup.sdk.reader.core.ResultError
Creates a new ResultError object.

S

showCustomTipField(boolean) - Method in class com.squareup.sdk.reader.checkout.TipSettings.Builder
Indicates whether custom tip amounts are allowed during the checkout flow.
showSeparateTipScreen(boolean) - Method in class com.squareup.sdk.reader.checkout.TipSettings.Builder
Indicates whether tip options should be presented on their own screen before presenting the signature screen during credit card transactions.
skipReceipt(boolean) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Indicates that the digital receipt options screen should not be displayed during checkout.
startCheckoutActivity(Context, CheckoutParameters) - Method in interface com.squareup.sdk.reader.checkout.CheckoutManager
Starts an activity that lets the application collect payment using Square's checkout flow.
startReaderSettingsActivity(Context) - Method in interface com.squareup.sdk.reader.hardware.ReaderManager
Starts an activity for connecting and managing Square Readers.
startStoreCardActivity(Context, String) - Method in interface com.squareup.sdk.reader.crm.CustomerCardManager
Starts an activity to store a card for a customer.
StoreCardActivityCallback - Interface in com.squareup.sdk.reader.crm
Callback type to receive notification on completion, successful or otherwise, of an attempt to save a card to a customer profile.
StoreCustomerCardErrorCode - Enum in com.squareup.sdk.reader.crm
Enumeration of the run-time errors that might occur when storing a card on file.

T

Tender - Class in com.squareup.sdk.reader.checkout
Represents a payment method used in a transaction.
Tender.Builder - Class in com.squareup.sdk.reader.checkout
Builder class for constructing Tender objects.
Tender.Type - Enum in com.squareup.sdk.reader.checkout
The payment method type.
TenderCardDetails - Class in com.squareup.sdk.reader.checkout
Represents additional details of a card payment.
TenderCardDetails.Builder - Class in com.squareup.sdk.reader.checkout
Builder class for constructing TenderCardDetails objects.
TenderCardDetails.EntryMethod - Enum in com.squareup.sdk.reader.checkout
The entry method used to provide a card's details.
TenderCashDetails - Class in com.squareup.sdk.reader.checkout
Represents additional details of a cash payment.
TenderCashDetails.Builder - Class in com.squareup.sdk.reader.checkout
Builder class for constructing TenderCashDetails objects.
tipMoney(Money) - Method in class com.squareup.sdk.reader.checkout.Tender.Builder
 
tipPercentages(int...) - Method in class com.squareup.sdk.reader.checkout.TipSettings.Builder
A list of tip percentages that should be presented during the checkout flow.
tipPercentages(List<Integer>) - Method in class com.squareup.sdk.reader.checkout.TipSettings.Builder
 
tipSettings(TipSettings) - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters.Builder
Configures tipping behavior for the checkout flow.
TipSettings - Class in com.squareup.sdk.reader.checkout
Settings that configure the tipping behavior of the checkout flow.
TipSettings.Builder - Class in com.squareup.sdk.reader.checkout
Builder class for constructing TipSettings objects.
toString() - Method in class com.squareup.sdk.reader.authorization.AuthorizationState
 
toString() - Method in class com.squareup.sdk.reader.authorization.Location
 
toString() - Method in class com.squareup.sdk.reader.checkout.Card
 
toString() - Method in class com.squareup.sdk.reader.checkout.CardReceiptDetails
 
toString() - Method in class com.squareup.sdk.reader.checkout.CheckoutParameters
 
toString() - Method in class com.squareup.sdk.reader.checkout.CheckoutResult
 
toString() - Method in class com.squareup.sdk.reader.checkout.Money
 
toString() - Method in class com.squareup.sdk.reader.checkout.Tender
 
toString() - Method in class com.squareup.sdk.reader.checkout.TenderCardDetails
 
toString() - Method in class com.squareup.sdk.reader.checkout.TenderCashDetails
 
toString() - Method in class com.squareup.sdk.reader.checkout.TipSettings
 
toString() - Method in class com.squareup.sdk.reader.core.Result
 
toString() - Method in class com.squareup.sdk.reader.core.ResultError
 
totalMoney(Money) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 
totalMoney(Money) - Method in class com.squareup.sdk.reader.checkout.Tender.Builder
 
totalTipMoney(Money) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 
transactionClientId(String) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 
transactionId(String) - Method in class com.squareup.sdk.reader.checkout.CheckoutResult.Builder
 

V

valueOf(String) - Static method in enum com.squareup.sdk.reader.authorization.AuthorizeErrorCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.authorization.DeauthorizeErrorCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.checkout.AdditionalPaymentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.checkout.Card.Brand
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.checkout.CheckoutErrorCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.checkout.CurrencyCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.checkout.Tender.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.checkout.TenderCardDetails.EntryMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.crm.StoreCustomerCardErrorCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.reader.hardware.ReaderSettingsErrorCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.squareup.sdk.reader.authorization.AuthorizeErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.authorization.DeauthorizeErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.checkout.AdditionalPaymentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.checkout.Card.Brand
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.checkout.CheckoutErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.checkout.CurrencyCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.checkout.Tender.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.checkout.TenderCardDetails.EntryMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.crm.StoreCustomerCardErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.reader.hardware.ReaderSettingsErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I L M N O P R S T V 
Skip navigation links