Creating App Shortcuts in Launcher

Overview

Android 7.1 allows you to define shortcuts to specific actions in your app. These shortcuts can be displayed in a supported launcher, such as the one provided with Nexus and Pixel devices. Shortcuts let your users quickly start common or recommended tasks within your app:

App shortcuts require Android 7.1 (API level 25) or higher, so your module’s compileSdk must be at least 25 — any current project already satisfies this — and runtime calls should be guarded with a version check as shown below. Pinned shortcuts additionally require Android 8.0 (API level 26) or higher. The examples below use the framework ShortcutManager API directly; Google also provides the ShortcutManagerCompat Jetpack helper, which reduces boilerplate and helps ensure shortcuts work consistently across Android versions.

Usage

Static shortcut

In your app’s manifest file (AndroidManifest.xml), find an activity whose intent filters are set to the android.intent.action.MAIN action and the android.intent.category.LAUNCHER category.

<activity
    android:name=".SplashActivity"
    android:screenOrientation="portrait"
    android:theme="@style/AppTheme.BrandedLaunch">
    <intent-filter>
        <action android:name="android.intent.action.MAIN" />

        <category android:name="android.intent.category.LAUNCHER" />
    </intent-filter>
    <meta-data android:name="android.app.shortcuts"
        android:resource="@xml/shortcut" />
</activity>

Your shortcut.xml will be under xml under res folder and will look like this

<shortcuts xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    tools:targetApi="25">
    <shortcut
        android:enabled="true"
        android:icon="@drawable/icon_name"
        android:shortcutId="shortcut_name"
        android:shortcutShortLabel="@string/name">
        <intent
            android:action="android.intent.action.VIEW"
            android:targetClass="com.example.app.MainActivity"
            android:targetPackage="com.example.app">
        </intent>
        <categories android:name="android.shortcut.conversation" />
    </shortcut>
</shortcuts>

Specify shortcut categories. Currently only SHORTCUT_CATEGORY_CONVERSATION is defined in the framework.
In the above Intent if your Activity is expecting some extras you can always pass it with extra tag like this.

<intent
    ...
       <extra
             android:name="key"
             android:value="value" />
</intent>

So this will create a static shortcut. We also have Dynamic Shortcuts — let’s see what they are. If you want to always show a shortcut in your app you can go with static shortcut, if you want some shortcuts to be Dynamic like text to a person which is Dynamic not same for all then you have to use Dynamic Shortcuts.

Dynamic Shortcut

To create a Dynamic Shortcut you will have to use these codes in your activity where you like to initialize the Shortcut.

@TargetApi(25)
private void createShortcut() {
    ShortcutManager sM = getSystemService(ShortcutManager.class);

    Intent intent1 = new Intent(getApplicationContext(), Activity1.class);
    intent1.setAction(Intent.ACTION_VIEW);

    ShortcutInfo shortcut1 = new ShortcutInfo.Builder(this, "shortcut1")
            .setIntent(intent1)
            .setShortLabel(getString(R.string.shortcut1))
            .setLongLabel("This is the shortcut 1")
            .setDisabledMessage("Login to open this")
            .setIcon(Icon.createWithResource(this, R.drawable.shortcut1))
            .build();

    sM.setDynamicShortcuts(Arrays.asList(shortcut1));
}

ShortcutManager uses system service so this has to be in an activity and remember this only works on Android 7.1 so it’s good to add the annotation @TargetApi(25) to this code to avoid compile errors and add version check before calling these methods.

if (Build.VERSION.SDK_INT >= 25) {
    createShortcut();
}else{
    removeShortcuts();
}

Also remember the Intent action setAction(); has to be set.
Remember users can pin the shortcuts as well, so it is dynamic or static they can always pin it, even if you remove dynamic shortcuts users will still have it if pinned. So if you are using Dynamic Shortcuts and you can’t do certain actions you have to disable those shortcuts. And that is where the Disabled messages get displayed.

@TargetApi(25)
private void removeShortcuts() {
    ShortcutManager shortcutManager = getSystemService(ShortcutManager.class);
    shortcutManager.disableShortcuts(Arrays.asList("shortcut1"));
    shortcutManager.removeAllDynamicShortcuts();
}

So the method disableShortcuts(List<String>) will disable the shortcuts whose id is passed. removeAllDynamicShortcuts(); will remove all the dynamic shortcuts.
See the Images below for example, left is normal shortcuts for a logged in user and right has two disabled shortcuts for Guest users and when pressed it displays the disabled messages set in the method setDisabledMessage(String).

All shortcuts enabled Some shortcuts disabled

So this is how we use app shortcuts on Android 7.1 and higher. The maximum number of static and dynamic shortcuts each launcher icon can have varies by device — query it with getMaxShortcutCountPerActivity() — and most supported launchers display up to four shortcuts at a time. You can use setRank(int) on ShortcutInfo.Builder to change the order of the shortcuts.

Resources

Check out the following links for more details: