mp

Class MpUtils

java.lang.Object

mp.MpUtils

public final class MpUtils
extends java.lang.Object

A helper class for querying enduser's purchase history or to figure out if this enduser is using an operator that is supported by Fortumo.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MESSAGE_STATUS_BILLED Constant value for message billing status indicating that payment was successful.
static int	MESSAGE_STATUS_FAILED Constant value for message billing status indicating that payment failed.
static int	MESSAGE_STATUS_NOT_SENT Constant value for message billing status indicating that no payment has been made.
static int	MESSAGE_STATUS_PENDING Constant value for message billing status indicating that payment is still pending.
static java.lang.String	PAYMENT_STATUS_CHANGED Action for status change intents, to be used in the manifest.
static int	PRODUCT_TYPE_CONSUMABLE Constant value for consumables.
static int	PRODUCT_TYPE_NON_CONSUMABLE Constant value for non-consumables, which can only purchased once.
static int	PRODUCT_TYPE_SUBSCRIPTION Constant value for subscription services.

Method Summary

Modifier and Type	Method and Description
static void	enablePaymentBroadcast(android.content.Context context, java.lang.String permission) Enables the PAYMENT_STATUS_CHANGED broadcast.
static void	fetchPaymentData(android.content.Context context, java.lang.String serviceId, java.lang.String inAppSecret) Allows the application to query the latest "small" XML payment data for a service and store it on device to be available offline.
static java.util.List<java.lang.String>	getFetchedPriceData(android.content.Context context, java.lang.String serviceId, java.lang.String inAppSecret) Returns the latest service price data that is stored on device and available offline.
static int	getLocalNonConsumablePaymentStatus(android.content.Context context, java.lang.String serviceId, java.lang.String productName) Returns non-consumable item purchase status as it is stored on the device.
static int	getNonConsumablePaymentStatus(android.content.Context context, java.lang.String serviceId, java.lang.String inAppSecret, java.lang.String productName) Returns the purchase status of a non-consumable item .
static PaymentResponse	getPaymentResponse(android.content.Context context, long messageId) Allows the application to query message status later. NB: This method might make a http request to Fortumo servers and can take considerable amount of time, avoid calling it in UI thread.
static java.util.List<PaymentResponse>	getPurchaseHistory(android.content.Context context, java.lang.String serviceId, java.lang.String inAppSecret, int timeout) Returns the list of purchased non-consumable items.
static boolean	isPaymentBroadcastEnabled(android.content.Context context)
static boolean	isSupportedOperator(android.content.Context context, java.lang.String serviceId, java.lang.String appId) Allows the application to query if user's carrier is supported by Fortumo.
static boolean	isSupportedOperator(android.content.Context context, java.lang.String serviceId, java.lang.String appId, long timeout) Allows the application to query if user's carrier is supported by Fortumo.

Methods inherited from class java.lang.Object

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

Field Detail

PAYMENT_STATUS_CHANGED

public static final java.lang.String PAYMENT_STATUS_CHANGED

Action for status change intents, to be used in the manifest.

 
 <receiver android:name=".PaymentStatusReceiver" ...>
   <intent-filter>
       <action android:name="mp.info.PAYMENT_STATUS_CHANGED" />
   </intent-filter>
 </receiver>
 
 

See Also:

Constant Field Values

MESSAGE_STATUS_NOT_SENT

public static final int MESSAGE_STATUS_NOT_SENT

Constant value for message billing status indicating that no payment has been made.

See Also:

Constant Field Values

MESSAGE_STATUS_PENDING

public static final int MESSAGE_STATUS_PENDING

Constant value for message billing status indicating that payment is still pending.

See Also:

Constant Field Values

MESSAGE_STATUS_BILLED

public static final int MESSAGE_STATUS_BILLED

Constant value for message billing status indicating that payment was successful.

See Also:

Constant Field Values

MESSAGE_STATUS_FAILED

public static final int MESSAGE_STATUS_FAILED

Constant value for message billing status indicating that payment failed.

See Also:

Constant Field Values

PRODUCT_TYPE_CONSUMABLE

public static final int PRODUCT_TYPE_CONSUMABLE

Constant value for consumables.

See Also:

Constant Field Values

PRODUCT_TYPE_NON_CONSUMABLE

public static final int PRODUCT_TYPE_NON_CONSUMABLE

Constant value for non-consumables, which can only purchased once.

See Also:

Constant Field Values

PRODUCT_TYPE_SUBSCRIPTION

public static final int PRODUCT_TYPE_SUBSCRIPTION

Constant value for subscription services.

See Also:

Constant Field Values

Method Detail

getPurchaseHistory

public static java.util.List<PaymentResponse> getPurchaseHistory(android.content.Context context,
                                                                 java.lang.String serviceId,
                                                                 java.lang.String inAppSecret,
                                                                 int timeout)

Returns the list of purchased non-consumable items. If internet connection is available, purchase data is first updated from server.

NB: If some items were purchased, but the application was re-installed or local data was deleted, and no internet connection is available, this method will always return an empty list.

NB: This method makes a http request to Fortumo servers and can take considerable amount of time, avoid calling it in UI thread.

Parameters:

serviceId - The service id the payment was made from (overrides the default service id)

inAppSecret - The in-app secret of the service

timeout - The timeout for the request to Fortumo servers in milliseconds

getPaymentResponse

public static PaymentResponse getPaymentResponse(android.content.Context context,
                                                 long messageId)

Allows the application to query message status later.
NB: This method might make a http request to Fortumo servers and can take considerable amount of time, avoid calling it in UI thread.

Parameters:

messageId - ID of the message as received from a PaymentResponse.getMessageId().

Returns:

A refreshed PaymentResponse object with the latest billing status.

Throws:

java.lang.IllegalArgumentException - message with the ID was not found

getLocalNonConsumablePaymentStatus

public static int getLocalNonConsumablePaymentStatus(android.content.Context context,
                                                     java.lang.String serviceId,
                                                     java.lang.String productName)

Returns non-consumable item purchase status as it is stored on the device.

NB: If an item was purchased, but the application was re-installed or local data was deleted, this method would always return MESSAGE_STATUS_NOT_SENT.

Parameters:

serviceId - The service id the payment was made from (overrides the default service id)

productName - productName of the message as specified when calling PaymentRequest.PaymentRequestBuilder.setProductName(String) NB: Only latin alphanumeric characters, dash ('-', hyphen-minus, U+002D) and underscore ('_', low line, U+005F) are supported and the value is truncated to 32 characters.

Returns:

one of MESSAGE_STATUS_NOT_SENT, MESSAGE_STATUS_PENDING, MESSAGE_STATUS_BILLED, MESSAGE_STATUS_FAILED

getNonConsumablePaymentStatus

public static int getNonConsumablePaymentStatus(android.content.Context context,
                                                java.lang.String serviceId,
                                                java.lang.String inAppSecret,
                                                java.lang.String productName)

Returns the purchase status of a non-consumable item . The status is checked locally from the device; if no local data is found and an internet connection is avalable, the status is checked from the server.

NB: If an item was purchased, but the application was re-installed or local data was deleted, and no internet connection is available, this method would always return MESSAGE_STATUS_NOT_SENT.

NB: This method might make a http request to Fortumo servers and can take considerable amount of time, avoid calling it in UI thread.

Parameters:

serviceId - The service id the payment was made from (overrides the default service id)

inAppSecret - The in-app secret of the service

productName - productName of the message as specified when calling PaymentRequest.PaymentRequestBuilder.setProductName(String) NB: Only latin alphanumeric characters, dash ('-', hyphen-minus, U+002D) and underscore ('_', low line, U+005F) are supported and the value is truncated to 32 characters.

Returns:

one of MESSAGE_STATUS_NOT_SENT, MESSAGE_STATUS_PENDING, MESSAGE_STATUS_BILLED, MESSAGE_STATUS_FAILED

enablePaymentBroadcast

public static void enablePaymentBroadcast(android.content.Context context,
                                          java.lang.String permission)

Enables the PAYMENT_STATUS_CHANGED broadcast. The PAYMENT_STATUS_CHANGED broadcast is disabled by default. For example this broadcast will allow to get a notification when the actual payment process starts and payment status first changes to MESSAGE_STATUS_PENDING. The broadcast will give similar information to a PaymentResponse object, the intent will contain extras with the following keys: billing_status, credit_amount (virtual credit sales only), credit_name (virtual credit sales only), message_id, payment_code, price_amount, price_currency, product_name, service_id, user_id
NB: To listen for this broadcast you must declare and implement a broadcast receiver with the correct permission.

Parameters:

permission - String naming a permission that a receiver must hold in order to receive your broadcast. If null, no permission is required.

isPaymentBroadcastEnabled

public static boolean isPaymentBroadcastEnabled(android.content.Context context)

isSupportedOperator

public static boolean isSupportedOperator(android.content.Context context,
                                          java.lang.String serviceId,
                                          java.lang.String appId)

Allows the application to query if user's carrier is supported by Fortumo.
NB: This method might make a http request to Fortumo servers and can take considerable amount of time, avoid calling it in UI thread.
NB: This method requires READ_PHONE_STATE permission.

Parameters:

serviceId - A service id, will override the default one

appId - The in-app secret of the service

Returns:

true if payments for this country-carrier combination are supported

isSupportedOperator

public static boolean isSupportedOperator(android.content.Context context,
                                          java.lang.String serviceId,
                                          java.lang.String appId,
                                          long timeout)

Allows the application to query if user's carrier is supported by Fortumo. It is similar to isSupportedOperator(Context, String, String) but allows overriding the timeout value parameters. The timeout determines how long the thread is waiting for the request to complete.
NB: This method makes a http request to Fortumo servers and can take considerable amount of time, avoid calling it in UI thread.
NB: This method requires READ_PHONE_STATE permission.

Parameters:

serviceId - A service id, will override the default one

appId - The in-app secret of the service

timeout - The timeout in milliseconds.

Returns:

true if payments for this country-carrier combination are supported

fetchPaymentData

public static void fetchPaymentData(android.content.Context context,
                                    java.lang.String serviceId,
                                    java.lang.String inAppSecret)

Allows the application to query the latest "small" XML payment data for a service and store it on device to be available offline. NB: This method makes a http request to Fortumo servers on a seperate thread.
NB: This method requires READ_PHONE_STATE permission.

Parameters:

serviceId - The ID of the service

inAppSecret - The in-app secret of the service

getFetchedPriceData

public static java.util.List<java.lang.String> getFetchedPriceData(android.content.Context context,
                                                                   java.lang.String serviceId,
                                                                   java.lang.String inAppSecret)

Returns the latest service price data that is stored on device and available offline. For single item services, the list contains one price. For virtual currency services, the list contains all available price points. Data is based on the latest "small" XML; if not available, the "big" XML; if no local data is available, an empty list is returned.

Parameters:

serviceId - The ID of the service

inAppSecret - The in-app secret of the service