Updated docs with clarifications on specific limitations with the new (edc354d3) · Commits · e / os / android_frameworks_base

core/java/android/view/inputmethod/InlineSuggestionsRequest.java

+19 −1

Original line number	Original line	Diff line number	Diff line
	@@ -47,6 +47,9 @@ public final class InlineSuggestionsRequest implements Parcelable {
	/**		/**
	* Max number of suggestions expected from the response. It must be a positive value.		* Max number of suggestions expected from the response. It must be a positive value.
	* Defaults to {@code SUGGESTION_COUNT_UNLIMITED} if not set.		* Defaults to {@code SUGGESTION_COUNT_UNLIMITED} if not set.
			*
			* <p>In practice, it is recommended that the max suggestion count does not exceed <b>5</b>
			* for performance reasons.</p>
	*/		*/
	private final int mMaxSuggestionCount;		private final int mMaxSuggestionCount;

	@@ -67,6 +70,9 @@ public final class InlineSuggestionsRequest implements Parcelable {
	/**		/**
	* The IME provided locales for the request. If non-empty, the inline suggestions should		* The IME provided locales for the request. If non-empty, the inline suggestions should
	* return languages from the supported locales. If not provided, it'll default to system locale.		* return languages from the supported locales. If not provided, it'll default to system locale.
			*
			* <p>Note for Autofill Providers: It is <b>recommended</b> for the returned inline suggestions
			* to have one locale to guarantee consistent UI rendering.</p>
	*/		*/
	private @NonNull LocaleList mSupportedLocales;		private @NonNull LocaleList mSupportedLocales;

	@@ -227,6 +233,9 @@ public final class InlineSuggestionsRequest implements Parcelable {
	/**		/**
	* Max number of suggestions expected from the response. It must be a positive value.		* Max number of suggestions expected from the response. It must be a positive value.
	* Defaults to {@code SUGGESTION_COUNT_UNLIMITED} if not set.		* Defaults to {@code SUGGESTION_COUNT_UNLIMITED} if not set.
			*
			* <p>In practice, it is recommended that the max suggestion count does not exceed <b>5</b>
			* for performance reasons.</p>
	*/		*/
	@DataClass.Generated.Member		@DataClass.Generated.Member
	public int getMaxSuggestionCount() {		public int getMaxSuggestionCount() {
	@@ -256,6 +265,9 @@ public final class InlineSuggestionsRequest implements Parcelable {
	/**		/**
	* The IME provided locales for the request. If non-empty, the inline suggestions should		* The IME provided locales for the request. If non-empty, the inline suggestions should
	* return languages from the supported locales. If not provided, it'll default to system locale.		* return languages from the supported locales. If not provided, it'll default to system locale.
			*
			* <p>Note for Autofill Providers: It is <b>recommended</b> for the returned inline suggestions
			* to have one locale to guarantee consistent UI rendering.</p>
	*/		*/
	@DataClass.Generated.Member		@DataClass.Generated.Member
	public @NonNull LocaleList getSupportedLocales() {		public @NonNull LocaleList getSupportedLocales() {
	@@ -458,6 +470,9 @@ public final class InlineSuggestionsRequest implements Parcelable {
	/**		/**
	* Max number of suggestions expected from the response. It must be a positive value.		* Max number of suggestions expected from the response. It must be a positive value.
	* Defaults to {@code SUGGESTION_COUNT_UNLIMITED} if not set.		* Defaults to {@code SUGGESTION_COUNT_UNLIMITED} if not set.
			*
			* <p>In practice, it is recommended that the max suggestion count does not exceed <b>5</b>
			* for performance reasons.</p>
	*/		*/
	@DataClass.Generated.Member		@DataClass.Generated.Member
	public @NonNull Builder setMaxSuggestionCount(int value) {		public @NonNull Builder setMaxSuggestionCount(int value) {
	@@ -508,6 +523,9 @@ public final class InlineSuggestionsRequest implements Parcelable {
	/**		/**
	* The IME provided locales for the request. If non-empty, the inline suggestions should		* The IME provided locales for the request. If non-empty, the inline suggestions should
	* return languages from the supported locales. If not provided, it'll default to system locale.		* return languages from the supported locales. If not provided, it'll default to system locale.
			*
			* <p>Note for Autofill Providers: It is <b>recommended</b> for the returned inline suggestions
			* to have one locale to guarantee consistent UI rendering.</p>
	*/		*/
	@DataClass.Generated.Member		@DataClass.Generated.Member
	public @NonNull Builder setSupportedLocales(@NonNull LocaleList value) {		public @NonNull Builder setSupportedLocales(@NonNull LocaleList value) {
	@@ -604,7 +622,7 @@ public final class InlineSuggestionsRequest implements Parcelable {
	}		}

	@DataClass.Generated(		@DataClass.Generated(
	time = 1588109685838L,		time = 1595457701315L,
	codegenVersion = "1.0.15",		codegenVersion = "1.0.15",
	sourceFile = "frameworks/base/core/java/android/view/inputmethod/InlineSuggestionsRequest.java",		sourceFile = "frameworks/base/core/java/android/view/inputmethod/InlineSuggestionsRequest.java",
	inputSignatures = "public static final int SUGGESTION_COUNT_UNLIMITED\nprivate final int mMaxSuggestionCount\nprivate final @android.annotation.NonNull java.util.List<android.widget.inline.InlinePresentationSpec> mInlinePresentationSpecs\nprivate @android.annotation.NonNull java.lang.String mHostPackageName\nprivate @android.annotation.NonNull android.os.LocaleList mSupportedLocales\nprivate @android.annotation.NonNull android.os.Bundle mExtras\nprivate @android.annotation.Nullable android.os.IBinder mHostInputToken\nprivate int mHostDisplayId\npublic void setHostInputToken(android.os.IBinder)\nprivate boolean extrasEquals(android.os.Bundle)\nprivate void parcelHostInputToken(android.os.Parcel,int)\nprivate @android.annotation.Nullable android.os.IBinder unparcelHostInputToken(android.os.Parcel)\npublic void setHostDisplayId(int)\nprivate void onConstructed()\npublic void filterContentTypes()\nprivate static int defaultMaxSuggestionCount()\nprivate static java.lang.String defaultHostPackageName()\nprivate static android.os.LocaleList defaultSupportedLocales()\nprivate static @android.annotation.Nullable android.os.IBinder defaultHostInputToken()\nprivate static @android.annotation.Nullable int defaultHostDisplayId()\nprivate static @android.annotation.NonNull android.os.Bundle defaultExtras()\nclass InlineSuggestionsRequest extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genEqualsHashCode=true, genToString=true, genBuilder=true)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setInlinePresentationSpecs(java.util.List<android.widget.inline.InlinePresentationSpec>)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setHostPackageName(java.lang.String)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setHostInputToken(android.os.IBinder)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setHostDisplayId(int)\nclass BaseBuilder extends java.lang.Object implements []")		inputSignatures = "public static final int SUGGESTION_COUNT_UNLIMITED\nprivate final int mMaxSuggestionCount\nprivate final @android.annotation.NonNull java.util.List<android.widget.inline.InlinePresentationSpec> mInlinePresentationSpecs\nprivate @android.annotation.NonNull java.lang.String mHostPackageName\nprivate @android.annotation.NonNull android.os.LocaleList mSupportedLocales\nprivate @android.annotation.NonNull android.os.Bundle mExtras\nprivate @android.annotation.Nullable android.os.IBinder mHostInputToken\nprivate int mHostDisplayId\npublic void setHostInputToken(android.os.IBinder)\nprivate boolean extrasEquals(android.os.Bundle)\nprivate void parcelHostInputToken(android.os.Parcel,int)\nprivate @android.annotation.Nullable android.os.IBinder unparcelHostInputToken(android.os.Parcel)\npublic void setHostDisplayId(int)\nprivate void onConstructed()\npublic void filterContentTypes()\nprivate static int defaultMaxSuggestionCount()\nprivate static java.lang.String defaultHostPackageName()\nprivate static android.os.LocaleList defaultSupportedLocales()\nprivate static @android.annotation.Nullable android.os.IBinder defaultHostInputToken()\nprivate static @android.annotation.Nullable int defaultHostDisplayId()\nprivate static @android.annotation.NonNull android.os.Bundle defaultExtras()\nclass InlineSuggestionsRequest extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genEqualsHashCode=true, genToString=true, genBuilder=true)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setInlinePresentationSpecs(java.util.List<android.widget.inline.InlinePresentationSpec>)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setHostPackageName(java.lang.String)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setHostInputToken(android.os.IBinder)\nabstract android.view.inputmethod.InlineSuggestionsRequest.Builder setHostDisplayId(int)\nclass BaseBuilder extends java.lang.Object implements []")

core/java/android/view/inputmethod/InlineSuggestionsResponse.java

+34 −4

Original line number	Original line	Diff line number	Diff line
	@@ -32,7 +32,18 @@ import java.util.List;
	*/		*/
	@DataClass(genEqualsHashCode = true, genToString = true, genHiddenConstructor = true)		@DataClass(genEqualsHashCode = true, genToString = true, genHiddenConstructor = true)
	public final class InlineSuggestionsResponse implements Parcelable {		public final class InlineSuggestionsResponse implements Parcelable {
	private final @NonNull List<InlineSuggestion> mInlineSuggestions;		/**
			* List of {@link InlineSuggestion}s returned as a part of this response.
			*
			* <p>When the host app requests to inflate this <b>ordered</b> list of inline suggestions by
			* calling {@link InlineSuggestion#inflate}, it is the host's responsibility to track the
			* order of the inflated {@link android.view.View}s. These views are to be added in
			* order to the view hierarchy, because the inflation calls will return asynchronously.</p>
			*
			* <p>The inflation ordering does not apply to the pinned icon.</p>
			*/
			@NonNull
			private final List<InlineSuggestion> mInlineSuggestions;

	/**		/**
	* Creates a new {@link InlineSuggestionsResponse}, for testing purpose.		* Creates a new {@link InlineSuggestionsResponse}, for testing purpose.
	@@ -48,7 +59,7 @@ public final class InlineSuggestionsResponse implements Parcelable {



	// Code below generated by codegen v1.0.14.		// Code below generated by codegen v1.0.15.
	//		//
	// DO NOT MODIFY!		// DO NOT MODIFY!
	// CHECKSTYLE:OFF Generated code		// CHECKSTYLE:OFF Generated code
	@@ -64,6 +75,15 @@ public final class InlineSuggestionsResponse implements Parcelable {
	/**		/**
	* Creates a new InlineSuggestionsResponse.		* Creates a new InlineSuggestionsResponse.
	*		*
			* @param inlineSuggestions
			* List of {@link InlineSuggestion}s returned as a part of this response.
			*
			* <p>When the host app requests to inflate this <b>ordered</b> list of inline suggestions by
			* calling {@link InlineSuggestion#inflate}, it is the host's responsibility to track the
			* order of the inflated {@link android.view.View}s. These views are to be added in
			* order to the view hierarchy, because the inflation calls will return asynchronously.</p>
			*
			* <p>The inflation ordering does not apply to the pinned icon.</p>
	* @hide		* @hide
	*/		*/
	@DataClass.Generated.Member		@DataClass.Generated.Member
	@@ -76,6 +96,16 @@ public final class InlineSuggestionsResponse implements Parcelable {
	// onConstructed(); // You can define this method to get a callback		// onConstructed(); // You can define this method to get a callback
	}		}

			/**
			* List of {@link InlineSuggestion}s returned as a part of this response.
			*
			* <p>When the host app requests to inflate this <b>ordered</b> list of inline suggestions by
			* calling {@link InlineSuggestion#inflate}, it is the host's responsibility to track the
			* order of the inflated {@link android.view.View}s. These views are to be added in
			* order to the view hierarchy, because the inflation calls will return asynchronously.</p>
			*
			* <p>The inflation ordering does not apply to the pinned icon.</p>
			*/
	@DataClass.Generated.Member		@DataClass.Generated.Member
	public @NonNull List<InlineSuggestion> getInlineSuggestions() {		public @NonNull List<InlineSuggestion> getInlineSuggestions() {
	return mInlineSuggestions;		return mInlineSuggestions;
	@@ -164,8 +194,8 @@ public final class InlineSuggestionsResponse implements Parcelable {
	};		};

	@DataClass.Generated(		@DataClass.Generated(
	time = 1578972149519L,		time = 1595891876037L,
	codegenVersion = "1.0.14",		codegenVersion = "1.0.15",
	sourceFile = "frameworks/base/core/java/android/view/inputmethod/InlineSuggestionsResponse.java",		sourceFile = "frameworks/base/core/java/android/view/inputmethod/InlineSuggestionsResponse.java",
	inputSignatures = "private final @android.annotation.NonNull java.util.List<android.view.inputmethod.InlineSuggestion> mInlineSuggestions\npublic static @android.annotation.TestApi @android.annotation.NonNull android.view.inputmethod.InlineSuggestionsResponse newInlineSuggestionsResponse(java.util.List<android.view.inputmethod.InlineSuggestion>)\nclass InlineSuggestionsResponse extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genEqualsHashCode=true, genToString=true, genHiddenConstructor=true)")		inputSignatures = "private final @android.annotation.NonNull java.util.List<android.view.inputmethod.InlineSuggestion> mInlineSuggestions\npublic static @android.annotation.TestApi @android.annotation.NonNull android.view.inputmethod.InlineSuggestionsResponse newInlineSuggestionsResponse(java.util.List<android.view.inputmethod.InlineSuggestion>)\nclass InlineSuggestionsResponse extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genEqualsHashCode=true, genToString=true, genHiddenConstructor=true)")
	@Deprecated		@Deprecated