com.scvngr.levelup.deeplinkauth

Class LevelUpDeepLinkIntegrator

java.lang.Object

com.scvngr.levelup.deeplinkauth.LevelUpDeepLinkIntegrator

public final class LevelUpDeepLinkIntegrator
extends Object

Deep Link Authorization allows third party apps to request an access token for a LevelUp user with Intents. The intent launches the LevelUp app and the user will be presented with a dialog describing the request for permissions. Upon choosing to accept or reject the request, the user will return to the requesting app which will be granted an access token if the request is accepted.

A request includes a list of permissions, such as the ability to create orders for the user or to access their transaction history. Permissions has definitions for some of the full list of available permissions.

To make an authorization request, first hook up the response handler. In your Activity's onActivityResult(), call parseActivityResult(int, int, android.content.Intent):

 protected void onActivityResult(int requestCode, int resultCode, Intent data) {
     // This pulls out your result from the data Intent.
     PermissionsRequestResult result =
             LevelUpDeepLinkIntegrator.parseActivityResult(requestCode, resultCode, data);

     if (result != null) {
         if (result.isSuccessful()) {
             // Result will contain your access token.
         } else {
             // The user declined the request or there was as error.
         }
     } else {
         // You can handle your own startActivityForResult results here.
     }
 }
 

When you are ready to request permissions, create an instance of LevelUpDeepLinkIntegrator from your Activity and call requestPermissions(java.util.Collection<java.lang.String>) with a list of desired permissions:

 if (LevelUpDeepLinkIntegrator.isLevelUpInstalled()) {
     LevelUpDeepLinkIntegrator integrator =
             new LevelUpDeepLinkIntegrator(yourActivity, yourAppId);
     integrator.requestPermissions(DeepLinkAuthUtil.Permissions.PERMISSION_CREATE_ORDERS);
 } else {
     // If you get here, LevelUp isn't installed or the installed version doesn't support
     // deep link auth. This might be a good place to suggest someone download LevelUp!
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LevelUpDeepLinkIntegrator.PermissionsRequestResult The result of a call to requestPermissions(java.util.Collection<java.lang.String>).

Constructor Summary

Constructors

Constructor and Description
LevelUpDeepLinkIntegrator(Activity activity, int appId) This can be instantiated in Activity.onCreate(android.os.Bundle).

Method Summary

Modifier and Type	Method and Description
protected AlertDialog	getInstallDialog(Activity activity) Constructs an AlertDialog which prompts the user to download LevelUp.
protected Uri	getPlayLink(Context context, String packageName) Retrieves the Google Play link for the given package name.
static boolean	isLevelUpAvailable(Context context)
protected AlertDialog	onLevelUpNotInstalled(Activity activity) Called when LevelUp is not installed.
protected void	onNegativeButton(DialogInterface dialog) Called when the negative action button (Cancel) is pressed on the install dialog.
protected void	onPositiveButton(DialogInterface dialog) Called when the positive action button (install LevelUp) is pressed in the install dialog.
static LevelUpDeepLinkIntegrator.PermissionsRequestResult	parseActivityResult(int requestCode, int resultCode, Intent data) Call this from Activity.onActivityResult(int, int, android.content.Intent).
AlertDialog	requestPermissions(Collection<String> permissionKeys) Send a request to the LevelUp app to prompt the user to grant your app the requested permissions.
AlertDialog	requestPermissions(String... permissionKeys) Send a request to the LevelUp app to prompt the user to grant your app the requested permissions.
void	setInstallDialogMessage(CharSequence message) Sets the message that's displayed when the LevelUp app isn't installed on the device.
void	setInstallDialogTitle(CharSequence title) Sets the title of the dialog box that's displayed when the LevelUp app isn't installed on the device.

Methods inherited from class java.lang.Object

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

Constructor Detail

LevelUpDeepLinkIntegrator

public LevelUpDeepLinkIntegrator(Activity activity,
                                 int appId)

This can be instantiated in Activity.onCreate(android.os.Bundle). This class keeps a weak reference to your activity, so you don't need to worry about it being leaked.

Parameters:

activity - your activity.

appId - your app's web service ID.

Method Detail

isLevelUpAvailable

public static boolean isLevelUpAvailable(Context context)

Parameters:

context - application context.

Returns:

true if a version of LevelUp that supports deep link authorization is installed and available. If false, you can handle the situation however you prefer, however we recommend that your app launches an intent that opens up LevelUp in Google Play so your users can download it.

parseActivityResult

public static LevelUpDeepLinkIntegrator.PermissionsRequestResult parseActivityResult(int requestCode,
                                                                                     int resultCode,
                                                                                     Intent data)

Call this from Activity.onActivityResult(int, int, android.content.Intent).

Parameters:

requestCode - the requestCode from onActivityResult

resultCode - the resultCode from onActivityResult

data - the data from onActivityResult

Returns:

the interpreted result. If the request code doesn't match, this returns null.

requestPermissions

public final AlertDialog requestPermissions(Collection<String> permissionKeys)

Send a request to the LevelUp app to prompt the user to grant your app the requested permissions. You must make sure to call parseActivityResult(int, int, android.content.Intent) from Activity.onActivityResult(int, int, android.content.Intent) in order to get the response from LevelUp.

Parameters:

permissionKeys - the set of permissions that you wish to request. See Permissions.

Returns:

the dialog box that was shown to the user with a link to download LevelUp if one was shown, otherwise null.

requestPermissions

public final AlertDialog requestPermissions(String... permissionKeys)

Send a request to the LevelUp app to prompt the user to grant your app the requested permissions. You must make sure to call parseActivityResult(int, int, android.content.Intent) from Activity.onActivityResult(int, int, android.content.Intent) in order to get the response from LevelUp.

Parameters:

permissionKeys - the set of permissions that you wish to request. See Permissions.

Returns:

the dialog box that was shown to the user with a link to download LevelUp if one was shown, otherwise null.

setInstallDialogMessage

public final void setInstallDialogMessage(CharSequence message)

Sets the message that's displayed when the LevelUp app isn't installed on the device.

Parameters:

message - the body text.

See Also:

R.string.levelup_deep_link_auth_install_message

setInstallDialogTitle

public final void setInstallDialogTitle(CharSequence title)

Sets the title of the dialog box that's displayed when the LevelUp app isn't installed on the device.

Parameters:

title - the dialog box's title.

See Also:

R.string.levelup_deep_link_auth_install_title

getInstallDialog

protected AlertDialog getInstallDialog(Activity activity)

Constructs an AlertDialog which prompts the user to download LevelUp. Alternative text can be set using setInstallDialogMessage(java.lang.CharSequence) and setInstallDialogTitle(java.lang.CharSequence) or by overlaying the associated strings resources.

Parameters:

activity - the activity that is responsible for the dialog (your activity).

Returns:

a created, but not shown dialog with two buttons.

getPlayLink

protected Uri getPlayLink(Context context,
                          String packageName)

Retrieves the Google Play link for the given package name.

Parameters:

context - application context.

packageName - the package to display.

Returns:

a URL that can be resolved on an Android device to show the given Google Play details page.

onLevelUpNotInstalled

protected AlertDialog onLevelUpNotInstalled(Activity activity)

Called when LevelUp is not installed.

Parameters:

activity -

Returns:

the AlertDialog that was shown to the user.

onNegativeButton

protected void onNegativeButton(DialogInterface dialog)

Called when the negative action button (Cancel) is pressed on the install dialog.

Parameters:

dialog -

onPositiveButton

protected void onPositiveButton(DialogInterface dialog)

Called when the positive action button (install LevelUp) is pressed in the install dialog.

Parameters:

dialog -