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

Commit fa07bb5c authored by lpeter's avatar lpeter
Browse files

Add some java doc in the VoiceInteractionSession 

Add the new case that we will also set AssistStructure to null.

Bug: 193512972
Test: build and manual
Change-Id: I431ba7d89787ec0b23cf8d1968dd23ac9178a59e
parent f1ecb267

core/java/android/service/voice/VoiceInteractionSession.java

+7 −4
Original line number Diff line number Diff line
@@ -1750,8 +1750,9 @@ public class VoiceInteractionSession implements KeyEvent.Callback, ComponentCall 
    /**

     * Called when there has been a failure transferring the {@link AssistStructure} to

     * the assistant.  This may happen, for example, if the data is too large and results

     * in an out of memory exception, or the client has provided corrupt data.  This will

     * be called immediately before {@link #onHandleAssist} and the AssistStructure supplied

     * in an out of memory exception, the data has been cleared during transferring due to

     * the new incoming assist data, or the client has provided corrupt data. This will be

     * called immediately before {@link #onHandleAssist} and the AssistStructure supplied

     * there afterwards will be null.

     *

     * @param failure The failure exception that was thrown when building the
@@ -1789,7 +1790,8 @@ public class VoiceInteractionSession implements KeyEvent.Callback, ComponentCall 
     * Called to receive data from the application that the user was currently viewing when

     * an assist session is started. If the original show request did not specify

     * {@link #SHOW_WITH_ASSIST}, {@link AssistState} parameter will only provide

     * {@link ActivityId}.

     * {@link ActivityId}. If there was a failure to write the assist data to

     * {@link AssistStructure}, the {@link AssistState#getAssistStructure()} will return null.

     *

     * <p>This method is called for all activities along with an index and count that indicates

     * which activity the data is for. {@code index} will be between 0 and {@code count}-1 and
@@ -2214,7 +2216,8 @@ public class VoiceInteractionSession implements KeyEvent.Callback, ComponentCall 
         * @return If available, the structure definition of all windows currently

         * displayed by the app. May be null if assist data has been disabled by the user

         * or device policy; will be null if the original show request did not specify

         * {@link #SHOW_WITH_ASSIST}; will be an empty stub if the application has disabled assist

         * {@link #SHOW_WITH_ASSIST} or the assist data has been corrupt when writing the data to

         * {@link AssistStructure}; will be an empty stub if the application has disabled assist

         * by marking its window as secure.

         */

        public @Nullable AssistStructure getAssistStructure() {