Skip to content

Document TranslationResponseValue APIs #432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 2 commits into from
Aug 14, 2026
+114 −26
Merged

Document TranslationResponseValue APIs #432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb48f2e
Document translation response value APIs
jonathanpeppers Aug 14, 2026
93cdcbe
Address translation documentation review
jonathanpeppers Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 84 additions & 20 deletions docs/xml/Android.Views.Translation/TranslationResponseValue+Builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,10 +184,24 @@
<Parameter Name="value" Type="Android.OS.Bundle" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">Extra results associated with the translated text.</param>
<summary>Sets extra results associated with the translated text.</summary>
<returns>This builder instance.</returns>
<remarks>
Comment thread
jonathanpeppers marked this conversation as resolved.
<para>Extra results associated with the translated text.</para>
<para>The bundle includes <c>TranslationResponseValue.ExtraDefinitions</c>, obtained by
<c>Bundle.GetBundle(string)</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/translation/TranslationResponseValue.Builder#setExtras(android.os.Bundle)" title="Reference documentation">Java documentation for <code>android.view.translation.TranslationResponseValue.Builder.setExtras(android.os.Bundle)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetText">
Expand Down Expand Up @@ -217,10 +231,22 @@
<Parameter Name="value" Type="Java.Lang.ICharSequence" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The translated text result.</param>
<summary>Sets the translated text result.</summary>
<returns>This builder instance.</returns>
<remarks>
<para>The translated text result.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/translation/TranslationResponseValue.Builder#setText(java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.translation.TranslationResponseValue.Builder.setText(java.lang.CharSequence)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetText">
Expand All @@ -246,10 +272,22 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The translated text result.</param>
<summary>Sets the translated text result.</summary>
<returns>This builder instance.</returns>
<remarks>
<para>The translated text result.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/translation/TranslationResponseValue.Builder#setText(java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.translation.TranslationResponseValue.Builder.setText(java.lang.CharSequence)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetTransliteration">
Expand Down Expand Up @@ -279,10 +317,23 @@
<Parameter Name="value" Type="Java.Lang.ICharSequence" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The transliteration result of the translated text.</param>
<summary>Sets the transliteration result of the translated text.</summary>
<returns>This builder instance.</returns>
<remarks>
<para>The transliteration result of the translated text.</para>
<para>The value represents the transliteration of the translated text.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/translation/TranslationResponseValue.Builder#setTransliteration(java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.translation.TranslationResponseValue.Builder.setTransliteration(java.lang.CharSequence)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetTransliteration">
Expand All @@ -308,10 +359,23 @@
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<param name="value">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="value">The transliteration result of the translated text.</param>
<summary>Sets the transliteration result of the translated text.</summary>
<returns>This builder instance.</returns>
<remarks>
<para>The transliteration result of the translated text.</para>
<para>The value represents the transliteration of the translated text.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/translation/TranslationResponseValue.Builder#setTransliteration(java.lang.CharSequence)" title="Reference documentation">Java documentation for <code>android.view.translation.TranslationResponseValue.Builder.setTransliteration(java.lang.CharSequence)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
36 changes: 30 additions & 6 deletions docs/xml/Android.Views.Translation/TranslationResponseValue.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,9 +461,21 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>The translated text result.</summary>
<value>The translated text result.</value>
<remarks>
<para>The translated text result.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getText()" title="Reference documentation">Java documentation for <code>android.view.translation.TranslationResponseValue.getText()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="TextFormatted">
Expand Down Expand Up @@ -593,9 +605,21 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>The transliteration result of the translated text.</summary>
<value>The transliteration result of the translated text.</value>
<remarks>
<para>The transliteration result of the translated text.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/translation/TranslationResponseValue#getTransliteration()" title="Reference documentation">Java documentation for <code>android.view.translation.TranslationResponseValue.getTransliteration()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
</Member>
<Member MemberName="TransliterationFormatted">
Expand Down