- 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
-
- 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
-
- 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.
- 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
-
- 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
-
- newCashTenderBuilder(Money, TenderCashDetails) - Static method in class com.squareup.sdk.reader.checkout.Tender
-
- 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
-
- 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
-
- 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.