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

Commit d871e180 authored by Ningyuan Wang's avatar Ningyuan Wang
Browse files

Document WifiScanner callback behaviors 

This adds the missing documents for WifiScanner.ActionListener.
This also fixes the existing inaccurate documents.

Bug: 29524465
Test: compile

Change-Id: I40d40a6293cdb0af6b8cad45062722ee2a4b746d
parent 8c4d17b4

wifi/java/android/net/wifi/WifiManager.java

+12 −4
Original line number Diff line number Diff line
@@ -2302,12 +2302,20 @@ public class WifiManager { 
     */

    @SystemApi

    public interface ActionListener {

        /** The operation succeeded */

        /**

         * The operation succeeded.

         * This is called when the scan request has been validated and ready

         * to sent to driver.

         */

        public void onSuccess();

        /**

         * The operation failed

         * @param reason The reason for failure could be one of

         * {@link #ERROR}, {@link #IN_PROGRESS} or {@link #BUSY}

         * The operation failed.

         * This is called when the scan request failed.

         * @param reason The reason for failure could be one of the following:

         * {@link #REASON_INVALID_REQUEST}} is specified when scan request parameters are invalid.

         * {@link #REASON_NOT_AUTHORIZED} is specified when requesting app doesn't have the required

         * permission to request a scan.

         * {@link #REASON_UNSPECIFIED} is specified when driver reports a scan failure.

         */

        public void onFailure(int reason);

    }