Package com.clover.sdk.v3.apps

Interface IAppsService

All Superinterfaces:

IInterface

All Known Implementing Classes:

IAppsService.Default, IAppsService.Stub

public interface IAppsService
extends IInterface

An interface for interacting with the v3 Clover apps service. The apps service is a bound AIDL service. Bind to this service as follows:

 
 Intent serviceIntent = new Intent(AppsIntent.ACTION_APPS_SERVICE);
 serviceIntent.putExtra(Intents.EXTRA_ACCOUNT, CloverAccount.getAccount(context));
 serviceIntent.putExtra(Intents.EXTRA_VERSION, 1);
 context.bindService(serviceIntent);
 
 

For more information about bound services, refer to the Android documentation: Bound Services .

You may also interact with the merchant service through the AppsConnector class, which handles binding and asynchronous invocation of service methods.

See Also:

AppsConnector

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IAppsService.Default	Default implementation for IAppsService.
static class	IAppsService.Stub	Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method	Description
App	getApp(ResultStatus resultStatus)	Get App object with information about this app.
AppBillingInfo	getAppBillingInfo(ResultStatus resultStatus)	Get AppBillingInfo object with billing information for the merchant running this app.
void	logMetered(String meteredId, int numberOfEvent, ResultStatus resultStatus)	Log a metered event occurance.
void	setSmartReceiptText(String text, ResultStatus resultStatus)	Update the Smart Receipt text for this app.
void	setSmartReceiptUrl(String url, ResultStatus resultStatus)	Update the Smart Receipt URL for this app.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

getApp

App getApp(ResultStatus resultStatus)
    throws RemoteException

Get App object with information about this app.

Parameters:

resultStatus - an output parameter with the result of the operation

Throws:

RemoteException

logMetered

void logMetered(String meteredId,
                int numberOfEvent,
                ResultStatus resultStatus)
         throws RemoteException

Log a metered event occurance. The merchant will be billed for this number of events.

Parameters:

meteredId - the id of the meter option to log

numberOfEvent - the count of how many events occured

resultStatus - an output parameter with the result of the operation

Throws:

RemoteException

getAppBillingInfo

AppBillingInfo getAppBillingInfo(ResultStatus resultStatus)
                          throws RemoteException

Get AppBillingInfo object with billing information for the merchant running this app.

Parameters:

resultStatus - an output parameter with the result of the operation

Throws:

RemoteException

setSmartReceiptText

void setSmartReceiptText(String text,
                         ResultStatus resultStatus)
                  throws RemoteException

Update the Smart Receipt text for this app. See the Clover developer site for more information about Smart Receipts.

Parameters:

text - the text to display on the receipt

resultStatus - an output parameter with the result of the operation

Throws:

RemoteException

setSmartReceiptUrl

void setSmartReceiptUrl(String url,
                        ResultStatus resultStatus)
                 throws RemoteException

Update the Smart Receipt URL for this app. See the Clover developer site for more information about Smart Receipts.

Parameters:

text - the URL to be used on the receipt

resultStatus - an output parameter with the result of the operation

Throws:

RemoteException