Index (point-of-sale-sdk 2.0 API)

A B C D E H I L N O P R S T V

A

AUTO_RETURN_NO_TIMEOUT - Static variable in class com.squareup.sdk.pos.PosApi
AUTO_RETURN_TIMEOUT_MAX_MILLIS - Static variable in class com.squareup.sdk.pos.PosApi
AUTO_RETURN_TIMEOUT_MIN_MILLIS - Static variable in class com.squareup.sdk.pos.PosApi
autoReturn(long, TimeUnit) - Method in class com.squareup.sdk.pos.ChargeRequest.Builder: After a transaction completes, Square Point of Sale automatically returns to your app after the timeout you provide to this method.
autoReturnMillis - Variable in class com.squareup.sdk.pos.ChargeRequest

B

build() - Method in class com.squareup.sdk.pos.ChargeRequest.Builder: Constructs a ChargeRequest from the current state of this builder.
Builder(int, CurrencyCode) - Constructor for class com.squareup.sdk.pos.ChargeRequest.Builder

C

ChargeRequest - Class in com.squareup.sdk.pos: Represents the details of a transaction to initiate with the Point of Sale API.
ChargeRequest.Builder - Class in com.squareup.sdk.pos: A flexible builder to create a ChargeRequest.
ChargeRequest.Error - Class in com.squareup.sdk.pos: Contains values returned by Square Point of Sale after failing to process a transaction.
ChargeRequest.ErrorCode - Enum in com.squareup.sdk.pos
ChargeRequest.Success - Class in com.squareup.sdk.pos: Contains values returned by Square Point of Sale after a successfully processed transaction.
ChargeRequest.TenderType - Enum in com.squareup.sdk.pos: Possible forms of payment that a merchant can accept for a Point of Sale API transaction.
clientTransactionId - Variable in class com.squareup.sdk.pos.ChargeRequest.Success: The device-generated ID of the transaction.
code - Variable in class com.squareup.sdk.pos.ChargeRequest.Error: Indicates the type of error that occurred.
com.squareup.sdk.pos - package com.squareup.sdk.pos
createChargeIntent(ChargeRequest) - Method in interface com.squareup.sdk.pos.PosClient: Creates an Intent that can be used to initiate a Square Point of Sale transaction.
createClient(Context, String) - Static method in class com.squareup.sdk.pos.PosSdk: Creates a new instance of PosClient that can then be used to create charge intents.
currencyCode - Variable in class com.squareup.sdk.pos.ChargeRequest
CurrencyCode - Enum in com.squareup.sdk.pos: ISO-4217 Currency Codes: http://www.currency-iso.org/dl_iso_table_a1.xml Names are the alpha-3 code.
customerId(String) - Method in class com.squareup.sdk.pos.ChargeRequest.Builder: Optional customer id to associate the sale to a specific customer.
customerId - Variable in class com.squareup.sdk.pos.ChargeRequest

D

debugDescription - Variable in class com.squareup.sdk.pos.ChargeRequest.Error: A debug string that describes the error that occurred.

E

enforceBusinessLocation(String) - Method in class com.squareup.sdk.pos.ChargeRequest.Builder: Requires a transaction to be processed by a particular location of a merchant's business.
equals(Object) - Method in class com.squareup.sdk.pos.ChargeRequest
Error(ChargeRequest.ErrorCode, String, String) - Constructor for class com.squareup.sdk.pos.ChargeRequest.Error
ERROR_CUSTOMER_MANAGEMENT_NOT_SUPPORTED - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_DISABLED - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_GIFT_CARDS_NOT_SUPPORTED - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_ILLEGAL_LOCATION_ID - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_INSUFFICIENT_CARD_BALANCE - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_INVALID_CUSTOMER_ID - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_INVALID_REQUEST - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_NO_EMPLOYEE_LOGGED_IN - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_NO_NETWORK - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_NO_RESULT - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_TRANSACTION_ALREADY_IN_PROGRESS - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_TRANSACTION_CANCELED - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_UNAUTHORIZED_CLIENT_ID - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_UNEXPECTED - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_UNSUPPORTED_API_VERSION - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_USER_NOT_ACTIVATED - Static variable in class com.squareup.sdk.pos.PosApi
ERROR_USER_NOT_LOGGED_IN - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_API_VERSION - Static variable in class com.squareup.sdk.pos.PosApi: API version number String extra.
EXTRA_AUTO_RETURN_TIMEOUT_MS - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_CURRENCY_CODE - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_CUSTOMER_ID - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_LOCATION_ID - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_NOTE - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_POINT_OF_SALE_CLIENT_ID - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_REQUEST_METADATA - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_SDK_VERSION - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_TENDER_CARD - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_TENDER_CARD_ON_FILE - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_TENDER_CASH - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_TENDER_OTHER - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_TENDER_TYPES - Static variable in class com.squareup.sdk.pos.PosApi
EXTRA_TOTAL_AMOUNT - Static variable in class com.squareup.sdk.pos.PosApi

H

hashCode() - Method in class com.squareup.sdk.pos.ChargeRequest

I

INTENT_ACTION_CHARGE - Static variable in class com.squareup.sdk.pos.PosApi
isPointOfSaleInstalled() - Method in interface com.squareup.sdk.pos.PosClient

L

launchPointOfSale() - Method in interface com.squareup.sdk.pos.PosClient: Launches the Square Point of Sale application.
locationId - Variable in class com.squareup.sdk.pos.ChargeRequest

N

newBuilder() - Method in class com.squareup.sdk.pos.ChargeRequest: Creates a new ChargeRequest.Builder copied from this transaction.
newBuilder(int, CurrencyCode) - Method in class com.squareup.sdk.pos.ChargeRequest: Creates a new ChargeRequest.Builder copied from this transaction, with a different amount.
note(String) - Method in class com.squareup.sdk.pos.ChargeRequest.Builder: Specifies a note to associate with a processed transaction.
note - Variable in class com.squareup.sdk.pos.ChargeRequest
NOTE_MAX_LENGTH - Static variable in class com.squareup.sdk.pos.PosApi

O

openPointOfSalePlayStoreListing() - Method in interface com.squareup.sdk.pos.PosClient: Opens the Square Point of Sale install page in the Google Play Store.

P

parseChargeError(Intent) - Method in interface com.squareup.sdk.pos.PosClient: Use this method to parse the data Intent passed in android.app.Activity#onActivityResult(int, int, Intent) when resultCode is equal to android.app.Activity#RESULT_CANCELED (canceled transaction).
parseChargeSuccess(Intent) - Method in interface com.squareup.sdk.pos.PosClient: Use this method to parse the data Intent passed in android.app.Activity#onActivityResult(int, int, Intent) when resultCode is equal to android.app.Activity#RESULT_OK (successful transaction).
PosApi - Class in com.squareup.sdk.pos: This class replicates constants used by Square Point of Sale for parsing Point of Sale API transaction requests.
PosClient - Interface in com.squareup.sdk.pos: Provides methods for interacting with the Square Point of Sale app, such as by generating Intents that initiate transactions.
PosSdk - Class in com.squareup.sdk.pos: The Point of Sale SDK lets you start the Square Point of Sale app to take transactions with the Square hardware.

R

requestMetadata(String) - Method in class com.squareup.sdk.pos.ChargeRequest.Builder: Optional request metadata that Square Point of Sale will return in its response, as ChargeRequest.Success.requestMetadata or Error#requestMetadata.
requestMetadata - Variable in class com.squareup.sdk.pos.ChargeRequest.Error: This value matches the value you provided to the ChargeRequest.Builder.requestMetadata(String) method when constructing the ChargeRequest, if any.
requestMetadata - Variable in class com.squareup.sdk.pos.ChargeRequest
requestMetadata - Variable in class com.squareup.sdk.pos.ChargeRequest.Success: This value matches the value you provided to the ChargeRequest.Builder.requestMetadata(String) method when constructing the ChargeRequest, if any.
restrictTendersTo(Collection<ChargeRequest.TenderType>) - Method in class com.squareup.sdk.pos.ChargeRequest.Builder: Restricts the payment methods the merchant can accept for the transaction.
restrictTendersTo(ChargeRequest.TenderType...) - Method in class com.squareup.sdk.pos.ChargeRequest.Builder
RESULT_CLIENT_TRANSACTION_ID - Static variable in class com.squareup.sdk.pos.PosApi
RESULT_ERROR_CODE - Static variable in class com.squareup.sdk.pos.PosApi
RESULT_ERROR_DESCRIPTION - Static variable in class com.squareup.sdk.pos.PosApi
RESULT_REQUEST_METADATA - Static variable in class com.squareup.sdk.pos.PosApi
RESULT_SERVER_TRANSACTION_ID - Static variable in class com.squareup.sdk.pos.PosApi

S

serverTransactionId - Variable in class com.squareup.sdk.pos.ChargeRequest.Success: The server-generated ID of the transaction, if available.
Success(String, String, String) - Constructor for class com.squareup.sdk.pos.ChargeRequest.Success

T

tenderTypes - Variable in class com.squareup.sdk.pos.ChargeRequest
totalAmount - Variable in class com.squareup.sdk.pos.ChargeRequest

V

valueOf(String) - Static method in enum com.squareup.sdk.pos.ChargeRequest.ErrorCode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.pos.ChargeRequest.TenderType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.sdk.pos.CurrencyCode: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.squareup.sdk.pos.ChargeRequest.ErrorCode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.pos.ChargeRequest.TenderType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.sdk.pos.CurrencyCode: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E H I L N O P R S T V