com.amazon.device.iap

Class PurchasingService

java.lang.Object

android.content.Context

android.content.ContextWrapper

android.app.Service

com.amazon.device.iap.PurchasingService

All Implemented Interfaces:

android.content.ComponentCallbacks, android.content.ComponentCallbacks2

public final class PurchasingService
extends android.app.Service

Presents the primary API for interacting with the Amazon Appstore purchasing framework. First register a PurchasingListener instance via registerListener(Context, PurchasingListener) before using any other API. You must add the following entry in your AndroidManifest.xml file:

 

 <!-- Include these lines in your AndroidManifest.xml -->
 <service
     android:exported="true"
     android:name="com.amazon.device.iap.PurchasingService"/>

 
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SDK_VERSION Indicates the release version of the API for making in-app purchases.

Fields inherited from class android.app.Service

START_CONTINUATION_MASK, START_FLAG_REDELIVERY, START_FLAG_RETRY, START_NOT_STICKY, START_REDELIVER_INTENT, START_STICKY, START_STICKY_COMPATIBILITY, STOP_FOREGROUND_DETACH, STOP_FOREGROUND_REMOVE

Fields inherited from class android.content.Context

ACCESSIBILITY_SERVICE, ACCOUNT_SERVICE, ACTIVITY_SERVICE, ALARM_SERVICE, APP_OPS_SERVICE, APPWIDGET_SERVICE, AUDIO_SERVICE, BATTERY_SERVICE, BIND_ABOVE_CLIENT, BIND_ADJUST_WITH_ACTIVITY, BIND_ALLOW_OOM_MANAGEMENT, BIND_AUTO_CREATE, BIND_DEBUG_UNBIND, BIND_EXTERNAL_SERVICE, BIND_IMPORTANT, BIND_NOT_FOREGROUND, BIND_WAIVE_PRIORITY, BLUETOOTH_SERVICE, CAMERA_SERVICE, CAPTIONING_SERVICE, CARRIER_CONFIG_SERVICE, CLIPBOARD_SERVICE, COMPANION_DEVICE_SERVICE, CONNECTIVITY_SERVICE, CONSUMER_IR_SERVICE, CONTEXT_IGNORE_SECURITY, CONTEXT_INCLUDE_CODE, CONTEXT_RESTRICTED, CROSS_PROFILE_APPS_SERVICE, DEVICE_POLICY_SERVICE, DISPLAY_SERVICE, DOWNLOAD_SERVICE, DROPBOX_SERVICE, EUICC_SERVICE, FINGERPRINT_SERVICE, HARDWARE_PROPERTIES_SERVICE, INPUT_METHOD_SERVICE, INPUT_SERVICE, IPSEC_SERVICE, JOB_SCHEDULER_SERVICE, KEYGUARD_SERVICE, LAUNCHER_APPS_SERVICE, LAYOUT_INFLATER_SERVICE, LOCATION_SERVICE, MEDIA_PROJECTION_SERVICE, MEDIA_ROUTER_SERVICE, MEDIA_SESSION_SERVICE, MIDI_SERVICE, MODE_APPEND, MODE_ENABLE_WRITE_AHEAD_LOGGING, MODE_MULTI_PROCESS, MODE_NO_LOCALIZED_COLLATORS, MODE_PRIVATE, MODE_WORLD_READABLE, MODE_WORLD_WRITEABLE, NETWORK_STATS_SERVICE, NFC_SERVICE, NOTIFICATION_SERVICE, NSD_SERVICE, POWER_SERVICE, PRINT_SERVICE, RECEIVER_VISIBLE_TO_INSTANT_APPS, RESTRICTIONS_SERVICE, SEARCH_SERVICE, SENSOR_SERVICE, SHORTCUT_SERVICE, STORAGE_SERVICE, STORAGE_STATS_SERVICE, SYSTEM_HEALTH_SERVICE, TELECOM_SERVICE, TELEPHONY_SERVICE, TELEPHONY_SUBSCRIPTION_SERVICE, TEXT_CLASSIFICATION_SERVICE, TEXT_SERVICES_MANAGER_SERVICE, TV_INPUT_SERVICE, UI_MODE_SERVICE, USAGE_STATS_SERVICE, USB_SERVICE, USER_SERVICE, VIBRATOR_SERVICE, WALLPAPER_SERVICE, WIFI_AWARE_SERVICE, WIFI_P2P_SERVICE, WIFI_RTT_RANGING_SERVICE, WIFI_SERVICE, WINDOW_SERVICE

Fields inherited from interface android.content.ComponentCallbacks2

TRIM_MEMORY_BACKGROUND, TRIM_MEMORY_COMPLETE, TRIM_MEMORY_MODERATE, TRIM_MEMORY_RUNNING_CRITICAL, TRIM_MEMORY_RUNNING_LOW, TRIM_MEMORY_RUNNING_MODERATE, TRIM_MEMORY_UI_HIDDEN

Constructor Summary

Constructors

Constructor and Description
PurchasingService()

Method Summary

Modifier and Type	Method and Description
static void	enablePendingPurchases() Apps must call this method if they want to support remote approval of purchases.
static RequestId	getProductData(java.util.Set<java.lang.String> skus) Initiates a request to retrieve item data of up to one-hundred SKUs.
static RequestId	getPurchaseUpdates(boolean reset) Initiates a request to retrieve updates about items the customer has purchased and/or canceled.
static RequestId	getUserData() Initiates a request to retrieve the user ID of the currently logged-in user.
static RequestId	getUserData(UserDataRequest userDataRequest) Initiates a request to retrieve the user details of the currently logged-in user.
static RequestId	modifySubscription(java.lang.String sku, ProrationMode prorationMode) Initiates a modifySubscription request for a subscription.
static void	notifyFulfillment(java.lang.String receiptId, FulfillmentResult fulfillmentResult) Notifies Amazon about the purchase fulfillment.
android.os.IBinder	onBind(android.content.Intent intent)
static RequestId	purchase(java.lang.String sku) Initiates a purchase-flow for a product.
static void	registerListener(android.content.Context appContext, ModifySubscriptionListener listener) Before invoking modifySubscription in this class, register a ModifySubscriptionListener and its Context.
static void	registerListener(android.content.Context appContext, PurchasingListener listener) Before invoking operations in this class, register a PurchasingListener and its Context.
static void	registerUserProfileAccessListener(android.content.Context appContext, UserProfileAccessListener listener) Before invoking operations in this class, register a UserProfileAccessListener and its Context.
static RequestId	requestUserProfileAccess() Initiates a request to retrieve the auth code of the currently logged-in user.

Methods inherited from class android.app.Service

dump, getApplication, onConfigurationChanged, onCreate, onDestroy, onLowMemory, onRebind, onStart, onStartCommand, onTaskRemoved, onTrimMemory, onUnbind, startForeground, stopForeground, stopForeground, stopSelf, stopSelf, stopSelfResult

Methods inherited from class android.content.ContextWrapper

attachBaseContext, bindService, checkCallingOrSelfPermission, checkCallingOrSelfUriPermission, checkCallingPermission, checkCallingUriPermission, checkPermission, checkSelfPermission, checkUriPermission, checkUriPermission, clearWallpaper, createConfigurationContext, createContextForSplit, createDeviceProtectedStorageContext, createDisplayContext, createPackageContext, databaseList, deleteDatabase, deleteFile, deleteSharedPreferences, enforceCallingOrSelfPermission, enforceCallingOrSelfUriPermission, enforceCallingPermission, enforceCallingUriPermission, enforcePermission, enforceUriPermission, enforceUriPermission, fileList, getApplicationContext, getApplicationInfo, getAssets, getBaseContext, getCacheDir, getClassLoader, getCodeCacheDir, getContentResolver, getDatabasePath, getDataDir, getDir, getExternalCacheDir, getExternalCacheDirs, getExternalFilesDir, getExternalFilesDirs, getExternalMediaDirs, getFilesDir, getFileStreamPath, getMainExecutor, getMainLooper, getNoBackupFilesDir, getObbDir, getObbDirs, getPackageCodePath, getPackageManager, getPackageName, getPackageResourcePath, getResources, getSharedPreferences, getSystemService, getSystemServiceName, getTheme, getWallpaper, getWallpaperDesiredMinimumHeight, getWallpaperDesiredMinimumWidth, grantUriPermission, isDeviceProtectedStorage, isRestricted, moveDatabaseFrom, moveSharedPreferencesFrom, openFileInput, openFileOutput, openOrCreateDatabase, openOrCreateDatabase, peekWallpaper, registerReceiver, registerReceiver, registerReceiver, registerReceiver, removeStickyBroadcast, removeStickyBroadcastAsUser, revokeUriPermission, revokeUriPermission, sendBroadcast, sendBroadcast, sendBroadcastAsUser, sendBroadcastAsUser, sendOrderedBroadcast, sendOrderedBroadcast, sendOrderedBroadcastAsUser, sendStickyBroadcast, sendStickyBroadcastAsUser, sendStickyOrderedBroadcast, sendStickyOrderedBroadcastAsUser, setTheme, setWallpaper, setWallpaper, startActivities, startActivities, startActivity, startActivity, startForegroundService, startInstrumentation, startIntentSender, startIntentSender, startService, stopService, unbindService, unregisterReceiver

Methods inherited from class android.content.Context

getColor, getColorStateList, getDrawable, getString, getString, getSystemService, getText, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, obtainStyledAttributes, registerComponentCallbacks, unregisterComponentCallbacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SDK_VERSION

public static final java.lang.String SDK_VERSION

Indicates the release version of the API for making in-app purchases.

See Also:

Constant Field Values

Constructor Detail

PurchasingService

public PurchasingService()

Method Detail

onBind

public android.os.IBinder onBind(android.content.Intent intent)

Specified by:

onBind in class android.app.Service

registerListener

public static void registerListener(android.content.Context appContext,
                                    PurchasingListener listener)

Before invoking operations in this class, register a PurchasingListener and its Context. After registering your PurchasingListener implementation, you can receive callbacks from the in-app purchasing SDK after you invoke operations on PurchasingService.

Parameters:

listener - PurchasingListener to register.

appContext - application context.

registerUserProfileAccessListener

public static void registerUserProfileAccessListener(android.content.Context appContext,
                                                     UserProfileAccessListener listener)

Before invoking operations in this class, register a UserProfileAccessListener and its Context. After registering your UserProfileAccessListener implementation, you can receive callbacks from the Appstore SDK after you invoke operations on PurchasingService.

Parameters:

listener - UserProfileAccessListener to register.

appContext - application context.

enablePendingPurchases

public static void enablePendingPurchases()

Apps must call this method if they want to support remote approval of purchases.

registerListener

public static void registerListener(android.content.Context appContext,
                                    ModifySubscriptionListener listener)

Before invoking modifySubscription in this class, register a ModifySubscriptionListener and its Context. After registering your ModifySubscriptionListener implementation, you can receive callbacks from the in-app purchasing SDK after you invoke modifySubscription on PurchasingService.

Parameters:

listener - ModifySubscriptionListener to register.

appContext - application context.

getUserData

public static RequestId getUserData()

Initiates a request to retrieve the user ID of the currently logged-in user. PurchasingListener.onUserDataResponse(com.amazon.device.iap.model.UserDataResponse) gets called when a response is available.

getUserData

public static RequestId getUserData(UserDataRequest userDataRequest)

Initiates a request to retrieve the user details of the currently logged-in user. PurchasingListener.onUserDataResponse(com.amazon.device.iap.model.UserDataResponse) gets called when a response is available.

Parameters:

userDataRequest - Request Parameters to initiate a query for User Data

purchase

public static RequestId purchase(java.lang.String sku)

Initiates a purchase-flow for a product. When the purchase-flow completes, PurchasingListener.onPurchaseResponse(PurchaseResponse) gets called.

Parameters:

sku - Vendor SKU for which to initiate a purchase.

Returns:

Request ID to use to associate this request with the PurchaseResponse received by the PurchasingListener.onPurchaseResponse(PurchaseResponse) callback.

modifySubscription

public static RequestId modifySubscription(java.lang.String sku,
                                           ProrationMode prorationMode)

Initiates a modifySubscription request for a subscription. When the modifySubscription completes, PurchasingListener#onModifySubscriptionResponse(ModifySubscriptionResponse) gets called.

Parameters:

sku - Vendor SKU for which to initiate a purchase.

prorationMode - ProrationMode Subscription proration mode

Returns:

Request ID to use to associate this request with the ModifySubscriptionResponse received by the PurchasingListener#onModifySubscriptionResponse(ModifySubscriptionResponse) callback.

getProductData

public static RequestId getProductData(java.util.Set<java.lang.String> skus)

Initiates a request to retrieve item data of up to one-hundred SKUs. When a response is available PurchasingListener.onProductDataResponse(com.amazon.device.iap.model.ProductDataResponse) gets called.

Parameters:

skus - Set of SKUs. If the size of the set is greater than 100, an IllegalArgumentException is thrown.

Returns:

Request ID for which to associate this request with the ProductDataResponse received by the PurchasingListener.onProductDataResponse(com.amazon.device.iap.model.ProductDataResponse) callback.

getPurchaseUpdates

public static RequestId getPurchaseUpdates(boolean reset)

Initiates a request to retrieve updates about items the customer has purchased and/or canceled. When a response is available, PurchasingListener.onPurchaseUpdatesResponse(com.amazon.device.iap.model.PurchaseUpdatesResponse) (PurchaseUpdatesResponse) gets called.

Parameters:

reset - Set to true to get a list of all purchases. Set to false to get a list of all purchases made since the last invocation.

Returns:

Request ID for which to associate this request with the PurchaseUpdatesResponse received by the PurchasingListener.onPurchaseUpdatesResponse(com.amazon.device.iap.model.PurchaseUpdatesResponse) callback.

notifyFulfillment

public static void notifyFulfillment(java.lang.String receiptId,
                                     FulfillmentResult fulfillmentResult)

Notifies Amazon about the purchase fulfillment. There is no callback for this API.

Parameters:

receiptId - Receipt ID of the purchase.

fulfillmentResult - Result of the fulfillment.

requestUserProfileAccess

public static RequestId requestUserProfileAccess()

Initiates a request to retrieve the auth code of the currently logged-in user. UserProfileAccessListener.onUserProfileAccessResponse(UserProfileAccessResponse)