bd.com.ipay.sdk

Class IPaySDK

java.lang.Object

bd.com.ipay.sdk.IPaySDK

public final class IPaySDK
extends java.lang.Object

This class is designed to initialize and customize the uses of iPay SDK.

Since:

1.0.0-SNAPSHOT

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IPaySDK.CheckoutState Values to mark Checkout State
static class	IPaySDK.CheckoutStatus Values to define Checkout Status
static interface	IPaySDK.InitializeCallback Callback passed to the initialize(Context) function.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECKOUT_ID_KEY checkout id key
static java.lang.String	CHECKOUT_STATUS_KEY checkout status key
static int	DEFAULT_CHECKOUT_REQUEST_CODE request code to create Checkout Activity.
static java.lang.String	IPAY_APP_PACKAGE_NAME iPay Bangladesh Ltd.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getCheckoutCallBackActivity()
static int	getCheckoutRequestCode()
static void	initialize(android.content.Context applicationContext) As iPay SDK initializes automatically(This function is called automatically on app start up), there is no necessity to call this method.
static void	initialize(android.content.Context applicationContext, IPaySDK.InitializeCallback initializeCallback) As iPay SDK initializes automatically(This function is called automatically on app start up), there is no necessity to call this method.
static boolean	isDebugLogEnabled()
static boolean	isInitialized() Indicates whether the iPay SDK has been initialized.
static IPaySDK.CheckoutState	performCheckout(android.app.Activity activity, java.lang.String checkoutUrl) If the device have iPay app installed, for a valid checkout url, this method will perform a checkout through iPay app.
static IPaySDK.CheckoutState	performCheckout(android.app.Activity activity, java.lang.String checkoutUrl, boolean shouldThrow) If the device have iPay app installed, for a valid checkout url, this method will perform a checkout through iPay app.
static IPaySDK.CheckoutState	performCheckout(android.app.Activity activity, java.lang.String checkoutUrl, boolean shouldThrow, boolean useCallbackActivity) If the device have iPay app installed, for a valid checkout url, this method will perform a checkout through iPay app.
static IPaySDK.CheckoutState	performCheckoutWithFallback(android.app.Activity activity, java.lang.String checkoutUrl, boolean useCallbackActivity, CheckoutCallbackActionUrls checkoutCallbackActionUrls) For a valid checkout url, this method will perform a checkout through iPay app.
static IPaySDK.CheckoutState	performCheckoutWithFallback(android.app.Activity activity, java.lang.String checkoutUrl, CheckoutCallbackActionUrls checkoutCallbackActionUrls) For a valid checkout url, this method will perform a checkout through iPay app.
static void	setCheckoutCallBackActivity(android.content.Context context, java.lang.String checkoutCallBackActivity)
static void	setCheckoutRequestCode(int requestCode) Sets request code for starting checkout activity.
static void	setDebugLogEnabled(boolean debugLogEnabled) Sets value to identify whether the SDK should Log SDK events.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHECKOUT_REQUEST_CODE

public static final int DEFAULT_CHECKOUT_REQUEST_CODE

request code to create Checkout Activity.

See Also:

Constant Field Values

IPAY_APP_PACKAGE_NAME

public static final java.lang.String IPAY_APP_PACKAGE_NAME

iPay Bangladesh Ltd. android app package name.

See Also:

Constant Field Values

CHECKOUT_STATUS_KEY

public static final java.lang.String CHECKOUT_STATUS_KEY

checkout status key

See Also:

Constant Field Values

CHECKOUT_ID_KEY

public static final java.lang.String CHECKOUT_ID_KEY

checkout id key

See Also:

Constant Field Values

Method Detail

initialize

public static void initialize(android.content.Context applicationContext)

As iPay SDK initializes automatically(This function is called automatically on app start up), there is no necessity to call this method. Although this method can be called manually if needed. This method mainly verifies few cases to check if the user mobile environment is suitable enough to perform iPay checkout.

Parameters:

applicationContext - The application context

initialize

public static void initialize(android.content.Context applicationContext,
                              IPaySDK.InitializeCallback initializeCallback)

As iPay SDK initializes automatically(This function is called automatically on app start up), there is no necessity to call this method. Although this method can be called manually if needed. This method mainly verifies few cases to check if the user mobile environment is suitable enough to perform iPay checkout.

Parameters:

applicationContext - The application context

initializeCallback - An initialize callback to get the status of the initialization.

performCheckout

public static IPaySDK.CheckoutState performCheckout(android.app.Activity activity,
                                                    java.lang.String checkoutUrl)

If the device have iPay app installed, for a valid checkout url, this method will perform a checkout through iPay app. In case of iPay isn't present it will open Play Store to install the iPay app.

Parameters:

activity - An android Activity

checkoutUrl - iPay checkout url

Returns:

performCheckout

public static IPaySDK.CheckoutState performCheckout(android.app.Activity activity,
                                                    java.lang.String checkoutUrl,
                                                    boolean shouldThrow)

If the device have iPay app installed, for a valid checkout url, this method will perform a checkout through iPay app. In case of iPay isn't present it can to do two things depending on the param shouldThrow value. If the value is true then it will throw an IPaySDKException exception. Otherwise it will open Play Store to install the iPay app.

Parameters:

activity - An android Activity

checkoutUrl - iPay checkout url

shouldThrow - should the method throw an exception for error or not

Throws:

IPaySDKException - if the param shouldThrow is true then this method will throw IPaySDKException if IPay app isn't installed on device.

performCheckout

public static IPaySDK.CheckoutState performCheckout(android.app.Activity activity,
                                                    java.lang.String checkoutUrl,
                                                    boolean shouldThrow,
                                                    boolean useCallbackActivity)

If the device have iPay app installed, for a valid checkout url, this method will perform a checkout through iPay app. In case of iPay isn't present it can to do two things depending on the param shouldThrow value. If the value is true then it will throw an IPaySDKException exception. Otherwise it will open Play Store to install the iPay app. When the param useCallbackActivity is true, after completing a checkout. IPaySDK will send necessary data to the provided callback activity not to the activity from it was called.

Parameters:

activity - An android Activity

checkoutUrl - iPay checkout url

shouldThrow - Should the method throw an exception for error or not

useCallbackActivity - Should the method send the data to another activity for completing the checkout or not

Returns:

the state of the checkout.

Throws:

IPaySDKException - if the param shouldThrow is true then this method will throw IPaySDKException if IPay app isn't installed on device.

performCheckoutWithFallback

public static IPaySDK.CheckoutState performCheckoutWithFallback(android.app.Activity activity,
                                                                java.lang.String checkoutUrl,
                                                                CheckoutCallbackActionUrls checkoutCallbackActionUrls)

For a valid checkout url, this method will perform a checkout through iPay app. In case of iPay isn't present it will checkout via WebView. IPaySDK will send necessary data to the calling activity.

Parameters:

activity - An android Activity

checkoutUrl - iPay checkout url

checkoutCallbackActionUrls - all three callback urls which was give to iPay during the creation of the checkout

Returns:

the state of the checkout.

performCheckoutWithFallback

public static IPaySDK.CheckoutState performCheckoutWithFallback(android.app.Activity activity,
                                                                java.lang.String checkoutUrl,
                                                                boolean useCallbackActivity,
                                                                CheckoutCallbackActionUrls checkoutCallbackActionUrls)

For a valid checkout url, this method will perform a checkout through iPay app. In case of iPay isn't present it will checkout via WebView. When the param useCallbackActivity is true, after completing a checkout. IPaySDK will send necessary data to the provided callback activity not to the activity from it was called.

Parameters:

activity - An android Activity

checkoutUrl - iPay checkout url

useCallbackActivity - Should the method send the data to another activity for completing the checkout or not

checkoutCallbackActionUrls - all three callback urls which was give to iPay during the creation of the checkout

Returns:

the state of the checkout.

isInitialized

public static boolean isInitialized()

Indicates whether the iPay SDK has been initialized.

Returns:

true if initialized, false if not

isDebugLogEnabled

public static boolean isDebugLogEnabled()

Returns:

boolean value of debug log enabled or not.

setDebugLogEnabled

public static void setDebugLogEnabled(boolean debugLogEnabled)

Sets value to identify whether the SDK should Log SDK events.

Parameters:

debugLogEnabled - indicates boolean value, whether the log should be printed or not.

getCheckoutRequestCode

public static int getCheckoutRequestCode()

Returns:

value of request code which used to start activity result of IPayCheckoutActivity.

setCheckoutRequestCode

public static void setCheckoutRequestCode(int requestCode)

Sets request code for starting checkout activity.

Parameters:

requestCode - Value for request code.

Throws:

java.lang.IllegalArgumentException - if the param value is less than 0.

getCheckoutCallBackActivity

public static java.lang.String getCheckoutCallBackActivity()

Returns:

Name of checkout callback activity name.

setCheckoutCallBackActivity

public static void setCheckoutCallBackActivity(android.content.Context context,
                                               java.lang.String checkoutCallBackActivity)

Parameters:

context - An android context

checkoutCallBackActivity - Callback activity canonical name

Throws:

java.lang.IllegalArgumentException - if the activity does not exists or not declared in AndroidManifest.xml. For more info see PackageManager.getActivityInfo(ComponentName, int)