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

Commit 1d75e795 authored by Cassie Wang's avatar Cassie Wang
Browse files

Replace @code with @link for setSchema. 

Now that the visibility APIs are exposed, we can properly @link to the
methods in the documentation.

Bug: 169883602
Test: presubmit
Change-Id: Ic5e9cb5f4279077cae72a566a631163ca7dd7264
parent 331f3be4

apex/appsearch/framework/java/android/app/appsearch/AppSearchSession.java

+5 −7
Original line number Diff line number Diff line
@@ -146,19 +146,17 @@ public final class AppSearchSession implements Closeable { 
     * <p>It is a no-op to set the same schema as has been previously set; this is handled

     * efficiently.

     *

     * <p>By default, documents are visible on platform surfaces. To opt out, call {@code

     * SetSchemaRequest.Builder#setPlatformSurfaceable} with {@code surfaceable} as false. Any

     * visibility settings apply only to the schemas that are included in the {@code request}.

     * Visibility settings for a schema type do not apply or persist across

     * {@link SetSchemaRequest}s.

     * <p>By default, documents are visible on platform surfaces. To opt out, call

     * {@link SetSchemaRequest.Builder#setSchemaTypeVisibilityForSystemUi} with {@code visible} as

     * false. Any visibility settings apply only to the schemas that are included in the

     * {@code request}. Visibility settings for a schema type do not persist across

     * {@link #setSchema} calls.

     *

     * @param request  The schema update request.

     * @param executor Executor on which to invoke the callback.

     * @param callback Callback to receive errors resulting from setting the schema. If the

     *                 operation succeeds, the callback will be invoked with {@code null}.

     */

    // TODO(b/169883602): Change @code references to @link when setPlatformSurfaceable APIs are

    //  exposed.

    public void setSchema(

            @NonNull SetSchemaRequest request,

            @NonNull @CallbackExecutor Executor executor,

apex/appsearch/testing/java/com/android/server/appsearch/testing/external/AppSearchSessionShim.java

+5 −7
Original line number Diff line number Diff line
@@ -86,11 +86,11 @@ public interface AppSearchSessionShim extends Closeable { 
     * <p>It is a no-op to set the same schema as has been previously set; this is handled

     * efficiently.

     *

     * <p>By default, documents are visible on platform surfaces. To opt out, call {@code

     * SetSchemaRequest.Builder#setPlatformSurfaceable} with {@code surfaceable} as false. Any

     * visibility settings apply only to the schemas that are included in the {@code request}.

     * Visibility settings for a schema type do not apply or persist across {@link

     * SetSchemaRequest}s.

     * <p>By default, documents are visible on platform surfaces. To opt out, call

     * {@link SetSchemaRequest.Builder#setSchemaTypeVisibilityForSystemUi} with {@code visible} as

     * false. Any visibility settings apply only to the schemas that are included in the

     * {@code request}. Visibility settings for a schema type do not persist across

     * {@link #setSchema} calls.

     *

     * <p>Migration: make non-backwards-compatible changes will delete all stored documents in old

     * schema. You can save your documents by setting {@link
@@ -116,8 +116,6 @@ public interface AppSearchSessionShim extends Closeable { 
     * @see android.app.appsearch.AppSearchSchema.Migrator

     * @see android.app.appsearch.AppSearchMigrationHelper.Transformer

     */

    // TODO(b/169883602): Change @code references to @link when setPlatformSurfaceable APIs are

    //  exposed.

    @NonNull

    ListenableFuture<SetSchemaResponse> setSchema(@NonNull SetSchemaRequest request);