com.scvngr.levelup.deeplinkauth

Class DeepLinkAuthUtil

java.lang.Object

com.scvngr.levelup.deeplinkauth.DeepLinkAuthUtil

public final class DeepLinkAuthUtil
extends Object

Utilities to support deep link authorization. This class is not intended to be used directly by 3rd party apps for integration; instead please see LevelUpDeepLinkIntegrator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeepLinkAuthUtil.LevelUpNotInstalledException Thrown if LevelUp is not installed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_REQUEST_PERMISSIONS Intent action for a permissions request.
static String	EXTRA_STRING_ACCESS_TOKEN Intent extra containing the access token.
static String	URI_QUERY_PARAMETER_APP_ID The authorization request query parameter containing the web service ID of the app requesting the permissions.
static String	URI_QUERY_PARAMETER_PERMISSION The authorization request query parameter containing one of the permissions to be requested.

Method Summary

Modifier and Type	Method and Description
static String	getPackageSignature(Context context, Intent request)
static String	getPackageSignature(Context context, String packageName) Given a package, retrieves the Google Maps-style API key signature.
static Intent	getRequestPermissionsIntent(Context context, int appId, Collection<String> permissions) Makes a request for permissions, verifying that the target of the Intent is authentically LevelUp.
static boolean	isLevelUpAvailable(Context context)

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_REQUEST_PERMISSIONS

public static final String ACTION_REQUEST_PERMISSIONS

Intent action for a permissions request.

See Also:

Constant Field Values

EXTRA_STRING_ACCESS_TOKEN

public static final String EXTRA_STRING_ACCESS_TOKEN

Intent extra containing the access token.

See Also:

Constant Field Values

URI_QUERY_PARAMETER_APP_ID

public static final String URI_QUERY_PARAMETER_APP_ID

The authorization request query parameter containing the web service ID of the app requesting the permissions.

See Also:

Constant Field Values

URI_QUERY_PARAMETER_PERMISSION

public static final String URI_QUERY_PARAMETER_PERMISSION

The authorization request query parameter containing one of the permissions to be requested. The URI can contain multiple of these parameters in order to encode a request for multiple permissions.

See Also:

Constant Field Values

Method Detail

getPackageSignature

public static String getPackageSignature(Context context,
                                         Intent request)

Parameters:

context - an Application context.

request - the intent in question.

Returns:

the Google Maps-style signature for the package that this intent resolves to or null if one could not be resolved.

See Also:

getPackageSignature(android.content.Context, String)

getPackageSignature

public static String getPackageSignature(Context context,
                                         String packageName)
                                  throws IllegalArgumentException

Given a package, retrieves the Google Maps-style API key signature. This is in the form of SIGNATURE;PACKAGE where SIGNATURE is the signature of the package, in upper case hexadecimal characters, grouped in bytes by ":". PACKAGE is the provided package name.

Parameters:

context - an Application context.

packageName - the name of the package.

Returns:

the package's signature.

Throws:

IllegalArgumentException - if the provided package has no signatures or is otherwise unusable.

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.

getRequestPermissionsIntent

public static Intent getRequestPermissionsIntent(Context context,
                                                 int appId,
                                                 Collection<String> permissions)
                                          throws DeepLinkAuthUtil.LevelUpNotInstalledException

Makes a request for permissions, verifying that the target of the Intent is authentically LevelUp.

Parameters:

context - application context.

appId - the web service ID of the app requesting the permissions.

permissions - the set of permissions.

Returns:

an intent intended to be sent with startActivityForResult().

Throws:

DeepLinkAuthUtil.LevelUpNotInstalledException - if LevelUp is not installed.