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

Commit 06de4e77 authored by Kenny Guy's avatar Kenny Guy
Browse files

Add support message for device admins 

Allow admins to set a long and short support
message for settings to display.

Bug: 25659579
Change-Id: Ib645490785642e49c69d8dbc65455eb3398547ee
parent c33f357b

api/current.txt

+4 −0
Original line number Diff line number Diff line
@@ -5755,6 +5755,7 @@ package android.app.admin { 
    method public java.lang.String getDeviceOwnerLockScreenInfo();

    method public java.util.List<byte[]> getInstalledCaCerts(android.content.ComponentName);

    method public int getKeyguardDisabledFeatures(android.content.ComponentName);

    method public java.lang.String getLongSupportMessage(android.content.ComponentName);

    method public int getMaximumFailedPasswordsForWipe(android.content.ComponentName);

    method public long getMaximumTimeToLock(android.content.ComponentName);

    method public boolean getPackageSuspended(android.content.ComponentName, java.lang.String);
@@ -5775,6 +5776,7 @@ package android.app.admin { 
    method public java.util.List<java.lang.String> getPermittedAccessibilityServices(android.content.ComponentName);

    method public java.util.List<java.lang.String> getPermittedInputMethods(android.content.ComponentName);

    method public boolean getScreenCaptureDisabled(android.content.ComponentName);

    method public java.lang.String getShortSupportMessage(android.content.ComponentName);

    method public boolean getStorageEncryption(android.content.ComponentName);

    method public int getStorageEncryptionStatus();

    method public android.app.admin.SystemUpdatePolicy getSystemUpdatePolicy();
@@ -5816,6 +5818,7 @@ package android.app.admin { 
    method public boolean setKeyguardDisabled(android.content.ComponentName, boolean);

    method public void setKeyguardDisabledFeatures(android.content.ComponentName, int);

    method public void setLockTaskPackages(android.content.ComponentName, java.lang.String[]) throws java.lang.SecurityException;

    method public void setLongSupportMessage(android.content.ComponentName, java.lang.String);

    method public void setMasterVolumeMuted(android.content.ComponentName, boolean);

    method public void setMaximumFailedPasswordsForWipe(android.content.ComponentName, int);

    method public void setMaximumTimeToLock(android.content.ComponentName, long);
@@ -5840,6 +5843,7 @@ package android.app.admin { 
    method public void setRestrictionsProvider(android.content.ComponentName, android.content.ComponentName);

    method public void setScreenCaptureDisabled(android.content.ComponentName, boolean);

    method public void setSecureSetting(android.content.ComponentName, java.lang.String, java.lang.String);

    method public void setShortSupportMessage(android.content.ComponentName, java.lang.String);

    method public boolean setStatusBarDisabled(android.content.ComponentName, boolean);

    method public int setStorageEncryption(android.content.ComponentName, boolean);

    method public void setSystemUpdatePolicy(android.content.ComponentName, android.app.admin.SystemUpdatePolicy);

api/system-current.txt

+4 −0
Original line number Diff line number Diff line
@@ -5883,6 +5883,7 @@ package android.app.admin { 
    method public java.lang.String getDeviceOwnerLockScreenInfo();

    method public java.util.List<byte[]> getInstalledCaCerts(android.content.ComponentName);

    method public int getKeyguardDisabledFeatures(android.content.ComponentName);

    method public java.lang.String getLongSupportMessage(android.content.ComponentName);

    method public int getMaximumFailedPasswordsForWipe(android.content.ComponentName);

    method public long getMaximumTimeToLock(android.content.ComponentName);

    method public boolean getPackageSuspended(android.content.ComponentName, java.lang.String);
@@ -5907,6 +5908,7 @@ package android.app.admin { 
    method public android.content.ComponentName getProfileOwner() throws java.lang.IllegalArgumentException;

    method public java.lang.String getProfileOwnerNameAsUser(int) throws java.lang.IllegalArgumentException;

    method public boolean getScreenCaptureDisabled(android.content.ComponentName);

    method public java.lang.String getShortSupportMessage(android.content.ComponentName);

    method public boolean getStorageEncryption(android.content.ComponentName);

    method public int getStorageEncryptionStatus();

    method public android.app.admin.SystemUpdatePolicy getSystemUpdatePolicy();
@@ -5950,6 +5952,7 @@ package android.app.admin { 
    method public boolean setKeyguardDisabled(android.content.ComponentName, boolean);

    method public void setKeyguardDisabledFeatures(android.content.ComponentName, int);

    method public void setLockTaskPackages(android.content.ComponentName, java.lang.String[]) throws java.lang.SecurityException;

    method public void setLongSupportMessage(android.content.ComponentName, java.lang.String);

    method public void setMasterVolumeMuted(android.content.ComponentName, boolean);

    method public void setMaximumFailedPasswordsForWipe(android.content.ComponentName, int);

    method public void setMaximumTimeToLock(android.content.ComponentName, long);
@@ -5974,6 +5977,7 @@ package android.app.admin { 
    method public void setRestrictionsProvider(android.content.ComponentName, android.content.ComponentName);

    method public void setScreenCaptureDisabled(android.content.ComponentName, boolean);

    method public void setSecureSetting(android.content.ComponentName, java.lang.String, java.lang.String);

    method public void setShortSupportMessage(android.content.ComponentName, java.lang.String);

    method public boolean setStatusBarDisabled(android.content.ComponentName, boolean);

    method public int setStorageEncryption(android.content.ComponentName, boolean);

    method public void setSystemUpdatePolicy(android.content.ComponentName, android.app.admin.SystemUpdatePolicy);

api/test-current.txt

+4 −0
Original line number Diff line number Diff line
@@ -5755,6 +5755,7 @@ package android.app.admin { 
    method public java.lang.String getDeviceOwnerLockScreenInfo();

    method public java.util.List<byte[]> getInstalledCaCerts(android.content.ComponentName);

    method public int getKeyguardDisabledFeatures(android.content.ComponentName);

    method public java.lang.String getLongSupportMessage(android.content.ComponentName);

    method public int getMaximumFailedPasswordsForWipe(android.content.ComponentName);

    method public long getMaximumTimeToLock(android.content.ComponentName);

    method public boolean getPackageSuspended(android.content.ComponentName, java.lang.String);
@@ -5775,6 +5776,7 @@ package android.app.admin { 
    method public java.util.List<java.lang.String> getPermittedAccessibilityServices(android.content.ComponentName);

    method public java.util.List<java.lang.String> getPermittedInputMethods(android.content.ComponentName);

    method public boolean getScreenCaptureDisabled(android.content.ComponentName);

    method public java.lang.String getShortSupportMessage(android.content.ComponentName);

    method public boolean getStorageEncryption(android.content.ComponentName);

    method public int getStorageEncryptionStatus();

    method public android.app.admin.SystemUpdatePolicy getSystemUpdatePolicy();
@@ -5816,6 +5818,7 @@ package android.app.admin { 
    method public boolean setKeyguardDisabled(android.content.ComponentName, boolean);

    method public void setKeyguardDisabledFeatures(android.content.ComponentName, int);

    method public void setLockTaskPackages(android.content.ComponentName, java.lang.String[]) throws java.lang.SecurityException;

    method public void setLongSupportMessage(android.content.ComponentName, java.lang.String);

    method public void setMasterVolumeMuted(android.content.ComponentName, boolean);

    method public void setMaximumFailedPasswordsForWipe(android.content.ComponentName, int);

    method public void setMaximumTimeToLock(android.content.ComponentName, long);
@@ -5840,6 +5843,7 @@ package android.app.admin { 
    method public void setRestrictionsProvider(android.content.ComponentName, android.content.ComponentName);

    method public void setScreenCaptureDisabled(android.content.ComponentName, boolean);

    method public void setSecureSetting(android.content.ComponentName, java.lang.String, java.lang.String);

    method public void setShortSupportMessage(android.content.ComponentName, java.lang.String);

    method public boolean setStatusBarDisabled(android.content.ComponentName, boolean);

    method public int setStorageEncryption(android.content.ComponentName, boolean);

    method public void setSystemUpdatePolicy(android.content.ComponentName, android.app.admin.SystemUpdatePolicy);

core/java/android/app/admin/DevicePolicyManager.java

+125 −0
Original line number Diff line number Diff line
@@ -4802,4 +4802,129 @@ public class DevicePolicyManager { 
            Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, re);

        }

    }



    /**

     * Called by a device admin to set the short support message. This will

     * be displayed to the user in settings screens where funtionality has

     * been disabled by the admin.

     *

     * The message should be limited to a short statement such as

     * "This setting is disabled by your administrator. Contact someone@example.com

     *  for support."

     * If the message is longer than 200 characters it may be truncated.

     *

     * @see #setLongSupportMessage

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @param message Short message to be displayed to the user in settings or null to

     *        clear the existing message.

     */

    public void setShortSupportMessage(@NonNull ComponentName admin,

            @Nullable String message) {

        if (mService != null) {

            try {

                mService.setShortSupportMessage(admin, message);

            } catch (RemoteException e) {

                Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);

            }

        }

    }



    /**

     * Called by a device admin to get the short support message.

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}

     *         or null if no message has been set.

     */

    public String getShortSupportMessage(@NonNull ComponentName admin) {

        if (mService != null) {

            try {

                return mService.getShortSupportMessage(admin);

            } catch (RemoteException e) {

                Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);

            }

        }

        return null;

    }



    /**

     * Called by a device admin to set the long support message. This will

     * be displayed to the user in the device administators settings screen.

     *

     * @see #setShortSupportMessage

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @param message Long message to be displayed to the user in settings or null to

     *        clear the existing message.

     */

    public void setLongSupportMessage(@NonNull ComponentName admin,

            @Nullable String message) {

        if (mService != null) {

            try {

                mService.setLongSupportMessage(admin, message);

            } catch (RemoteException e) {

                Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);

            }

        }

    }



    /**

     * Called by a device admin to get the long support message.

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}

     *         or null if no message has been set.

     */

    public String getLongSupportMessage(@NonNull ComponentName admin) {

        if (mService != null) {

            try {

                return mService.getLongSupportMessage(admin);

            } catch (RemoteException e) {

                Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);

            }

        }

        return null;

    }



    /**

     * Called by the system to get the short support message.

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @param userHandle user id the admin is running as.

     * @return The message set by {@link #setShortSupportMessage(ComponentName, String)}

     *

     * @hide

     */

    public String getShortSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {

        if (mService != null) {

            try {

                return mService.getShortSupportMessageForUser(admin, userHandle);

            } catch (RemoteException e) {

                Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);

            }

        }

        return null;

    }





    /**

     * Called by the system to get the long support message.

     *

     * @param admin Which {@link DeviceAdminReceiver} this request is associated with.

     * @param userHandle user id the admin is running as.

     * @return The message set by {@link #setLongSupportMessage(ComponentName, String)}

     *

     * @hide

     */

    public String getLongSupportMessageForUser(@NonNull ComponentName admin, int userHandle) {

        if (mService != null) {

            try {

                return mService.getLongSupportMessageForUser(admin, userHandle);

            } catch (RemoteException e) {

                Log.w(TAG, REMOTE_EXCEPTION_MESSAGE, e);

            }

        }

        return null;

    }

}

core/java/android/app/admin/IDevicePolicyManager.aidl

+8 −0
Original line number Diff line number Diff line
@@ -245,4 +245,12 @@ interface IDevicePolicyManager { 
    boolean isSystemOnlyUser(in ComponentName admin);

    String getWifiMacAddress();

    void reboot(in ComponentName admin);



    void setShortSupportMessage(in ComponentName admin, in String message);

    String getShortSupportMessage(in ComponentName admin);

    void setLongSupportMessage(in ComponentName admin, in String message);

    String getLongSupportMessage(in ComponentName admin);



    String getShortSupportMessageForUser(in ComponentName admin, int userHandle);

    String getLongSupportMessageForUser(in ComponentName admin, int userHandle);

}