com.squareup.sdk.pos

Interface PosClient

public interface PosClient

Provides methods for interacting with the Square Point of Sale app, such as by generating Intents that initiate transactions.

Method Summary

Modifier and Type	Method and Description
android.content.Intent	createChargeIntent(ChargeRequest chargeRequest) Creates an Intent that can be used to initiate a Square Point of Sale transaction.
boolean	isPointOfSaleInstalled()
void	launchPointOfSale() Launches the Square Point of Sale application.
void	openPointOfSalePlayStoreListing() Opens the Square Point of Sale install page in the Google Play Store.
ChargeRequest.Error	parseChargeError(android.content.Intent data) 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).
ChargeRequest.Success	parseChargeSuccess(android.content.Intent data) 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).

Method Detail

createChargeIntent

android.content.Intent createChargeIntent(ChargeRequest chargeRequest)

Creates an Intent that can be used to initiate a Square Point of Sale transaction. Provide the created Intent to the android.app.Activity#startActivityForResult(Intent, int) to initiate the transaction.

Throws:

android.content.ActivityNotFoundException - if Square Point of Sale is not installed.

java.lang.NullPointerException - if chargeRequest is null.

See Also:

PosSdk

isPointOfSaleInstalled

boolean isPointOfSaleInstalled()

Returns:

true if a version of Square Point of Sale that supports the Point of Sale API is installed, false otherwise.

launchPointOfSale

void launchPointOfSale()

Launches the Square Point of Sale application. This is equivalent to pressing the home button and opening the Point of Sale app. It is useful for handling errors that require the user to complete an action within Point of Sale, such as completing a transaction after receiving a ChargeRequest.ErrorCode.TRANSACTION_ALREADY_IN_PROGRESS error.

Throws:

android.content.ActivityNotFoundException - if Square Point of Sale is not installed.

openPointOfSalePlayStoreListing

void openPointOfSalePlayStoreListing()

Opens the Square Point of Sale install page in the Google Play Store. The Play Store activity is started using the application context.

parseChargeSuccess

ChargeRequest.Success parseChargeSuccess(android.content.Intent data)

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).

parseChargeError

ChargeRequest.Error parseChargeError(android.content.Intent data)

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).