Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 78808a59 authored by Pierre Barbier de Reuille's avatar Pierre Barbier de Reuille
Browse files

Update the documentation of AppWidgetManager 

AppWidgetManager#bindAppWidgetIdIfAllowed sends a broadcast when
successful, but this is currently not documented. The behavior was
introduced in 2014 by a change in the AppWidgetServiceImpl.

Bug: 189334092
Test: N/A (documentation only)
Change-Id: Iba83b89fd60c7f658a1fe911a260b666638fb020
parent ad970d64

core/java/android/appwidget/AppWidgetManager.java

+10 −0
Original line number Diff line number Diff line
@@ -963,6 +963,9 @@ public class AppWidgetManager { 
    /**

     * Set the component for a given appWidgetId.

     *

     * If successful, the app widget provider will receive a {@link #ACTION_APPWIDGET_UPDATE}

     * broadcast.

     *

     * <p class="note">You need the BIND_APPWIDGET permission or the user must have enabled binding

     *         widgets always for your component. Should be used by apps that host widgets; if this

     *         method returns false, call {@link #ACTION_APPWIDGET_BIND} to request permission to
@@ -983,6 +986,9 @@ public class AppWidgetManager { 
    /**

     * Set the component for a given appWidgetId.

     *

     * If successful, the app widget provider will receive a {@link #ACTION_APPWIDGET_UPDATE}

     * broadcast.

     *

     * <p class="note">You need the BIND_APPWIDGET permission or the user must have enabled binding

     *         widgets always for your component. Should be used by apps that host widgets; if this

     *         method returns false, call {@link #ACTION_APPWIDGET_BIND} to request permission to
@@ -1006,6 +1012,10 @@ public class AppWidgetManager { 


    /**

     * Set the provider for a given appWidgetId if the caller has a permission.

     *

     * If successful, the app widget provider will receive a {@link #ACTION_APPWIDGET_UPDATE}

     * broadcast.

     *

     * <p>

     * <strong>Note:</strong> You need the {@link android.Manifest.permission#BIND_APPWIDGET}

     * permission or the user must have enabled binding widgets always for your component.