Skip to content
This repository was archived by the owner on May 29, 2024. It is now read-only.

Commit 3f64bdd

Browse files
pjcollinsVSC-Service-Accountdavidbritch
authored
Import documentation for API-34 (#52)
Update `Mono.Android.dll` documentation, importing the Google-provided API-34 Javadoc documentation. Adds side by side support for "Xamarin.Android 13" and ".NET Android 34" versioned documentation. Docs were updated with: dotnet/android@df08bb3 Additional remarks content has been enabled via: dotnet/android@07dc60b Co-authored-by: VSC-Service-Account <[email protected]> Co-authored-by: David Britch <[email protected]>
1 parent 2d3e40a commit 3f64bdd

File tree

9,088 files changed

+845453
-87347
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

9,088 files changed

+845453
-87347
lines changed

.openpublishing.publish.config.json

+1-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55
"build_source_folder": "docs/Mono.Android/en",
66
"build_output_subfolder": "XamarinAndroidAPI",
77
"locale": "en-us",
8-
"monikers": [
9-
"xamarin-android-sdk-13"
10-
],
8+
"monikers": [],
119
"moniker_ranges": [],
1210
"open_to_public_contributors": false,
1311
"type_mapping": {

docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityButtonController+AccessibilityButtonCallback.xml

+23
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,17 @@
1616
<AttributeName Language="C#">[Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback", ApiSince=26, DoNotGenerateAcw=true)]</AttributeName>
1717
<AttributeName Language="F#">[&lt;Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback", ApiSince=26, DoNotGenerateAcw=true)&gt;]</AttributeName>
1818
</Attribute>
19+
<Attribute>
20+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
21+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
22+
</Attribute>
1923
</Attributes>
2024
<Docs>
2125
<summary>Callback for interaction with and changes to state of the accessibility button
2226
within the system's navigation area.</summary>
2327
<remarks>
28+
<para>Callback for interaction with and changes to state of the accessibility button
29+
within the system's navigation area.</para>
2430
<para>
2531
<format type="text/html">
2632
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController.AccessibilityButtonCallback" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.AccessibilityButtonCallback</code>.</a>
@@ -48,6 +54,10 @@
4854
<AttributeName Language="C#">[Android.Runtime.Register(".ctor", "()V", "", ApiSince=26)]</AttributeName>
4955
<AttributeName Language="F#">[&lt;Android.Runtime.Register(".ctor", "()V", "", ApiSince=26)&gt;]</AttributeName>
5056
</Attribute>
57+
<Attribute>
58+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
59+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
60+
</Attribute>
5161
</Attributes>
5262
<Parameters />
5363
<Docs>
@@ -126,6 +136,10 @@
126136
<AttributeName Language="C#">[Android.Runtime.Register("onAvailabilityChanged", "(Landroid/accessibilityservice/AccessibilityButtonController;Z)V", "GetOnAvailabilityChanged_Landroid_accessibilityservice_AccessibilityButtonController_ZHandler", ApiSince=26)]</AttributeName>
127137
<AttributeName Language="F#">[&lt;Android.Runtime.Register("onAvailabilityChanged", "(Landroid/accessibilityservice/AccessibilityButtonController;Z)V", "GetOnAvailabilityChanged_Landroid_accessibilityservice_AccessibilityButtonController_ZHandler", ApiSince=26)&gt;]</AttributeName>
128138
</Attribute>
139+
<Attribute>
140+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
141+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
142+
</Attribute>
129143
</Attributes>
130144
<ReturnValue>
131145
<ReturnType>System.Void</ReturnType>
@@ -142,6 +156,10 @@
142156
<summary>Called when the availability of the accessibility button in the system's
143157
navigation area has changed.</summary>
144158
<remarks>
159+
<para>Called when the availability of the accessibility button in the system's
160+
navigation area has changed. The accessibility button may become unavailable
161+
because the device shopped showing the button, the button was assigned to another
162+
service, or for other reasons.</para>
145163
<para>
146164
<format type="text/html">
147165
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController.AccessibilityButtonCallback#onAvailabilityChanged(android.accessibilityservice.AccessibilityButtonController,%20boolean)" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.AccessibilityButtonCallback.onAvailabilityChanged(android.accessibilityservice.AccessibilityButtonController, boolean)</code>.</a>
@@ -170,6 +188,10 @@
170188
<AttributeName Language="C#">[Android.Runtime.Register("onClicked", "(Landroid/accessibilityservice/AccessibilityButtonController;)V", "GetOnClicked_Landroid_accessibilityservice_AccessibilityButtonController_Handler", ApiSince=26)]</AttributeName>
171189
<AttributeName Language="F#">[&lt;Android.Runtime.Register("onClicked", "(Landroid/accessibilityservice/AccessibilityButtonController;)V", "GetOnClicked_Landroid_accessibilityservice_AccessibilityButtonController_Handler", ApiSince=26)&gt;]</AttributeName>
172190
</Attribute>
191+
<Attribute>
192+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
193+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
194+
</Attribute>
173195
</Attributes>
174196
<ReturnValue>
175197
<ReturnType>System.Void</ReturnType>
@@ -181,6 +203,7 @@
181203
<param name="controller">the controller used to register for this callback</param>
182204
<summary>Called when the accessibility button in the system's navigation area is clicked.</summary>
183205
<remarks>
206+
<para>Called when the accessibility button in the system's navigation area is clicked.</para>
184207
<para>
185208
<format type="text/html">
186209
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController.AccessibilityButtonCallback#onClicked(android.accessibilityservice.AccessibilityButtonController)" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.AccessibilityButtonCallback.onClicked(android.accessibilityservice.AccessibilityButtonController)</code>.</a>

docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityButtonController.xml

+42
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,31 @@
1616
<AttributeName Language="C#">[Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController", ApiSince=26, DoNotGenerateAcw=true)]</AttributeName>
1717
<AttributeName Language="F#">[&lt;Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController", ApiSince=26, DoNotGenerateAcw=true)&gt;]</AttributeName>
1818
</Attribute>
19+
<Attribute>
20+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
21+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
22+
</Attribute>
1923
</Attributes>
2024
<Docs>
2125
<summary>Controller for the accessibility button within the system's navigation area</summary>
2226
<remarks>
27+
<para>Controller for the accessibility button within the system's navigation area</para>
28+
<para>This class may be used to query the accessibility button's state and register
29+
callbacks for interactions with and state changes to the accessibility button when
30+
<c>AccessibilityServiceInfo#FLAG_REQUEST_ACCESSIBILITY_BUTTON</c> is set.</para>
31+
<para>&lt;strong&gt;Note:&lt;/strong&gt; This class and
32+
<c>AccessibilityServiceInfo#FLAG_REQUEST_ACCESSIBILITY_BUTTON</c> should not be used as
33+
the sole means for offering functionality to users via an <c>AccessibilityService</c>.
34+
Some device implementations may choose not to provide a software-rendered system
35+
navigation area, making this affordance permanently unavailable.</para>
36+
<para>&lt;strong&gt;Note:&lt;/strong&gt; On device implementations where the accessibility button is
37+
supported, it may not be available at all times, such as when a foreground application uses
38+
<c>android.view.View#SYSTEM_UI_FLAG_HIDE_NAVIGATION</c>. A user may also choose to assign
39+
this button to another accessibility service or feature. In each of these cases, a
40+
registered <c>AccessibilityButtonCallback</c>'s
41+
<c>AccessibilityButtonCallback#onAvailabilityChanged(AccessibilityButtonController, boolean)</c>
42+
method will be invoked to provide notifications of changes in the accessibility button's
43+
availability to the registering service.</para>
2344
<para>
2445
<format type="text/html">
2546
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController</code>.</a>
@@ -44,6 +65,10 @@
4465
<AssemblyVersion>0.0.0.0</AssemblyVersion>
4566
</AssemblyInfo>
4667
<Attributes>
68+
<Attribute>
69+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
70+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
71+
</Attribute>
4772
<Attribute>
4873
<AttributeName Language="C#">[get: Android.Runtime.Register("isAccessibilityButtonAvailable", "()Z", "", ApiSince=26)]</AttributeName>
4974
<AttributeName Language="F#">[&lt;get: Android.Runtime.Register("isAccessibilityButtonAvailable", "()Z", "", ApiSince=26)&gt;]</AttributeName>
@@ -59,6 +84,11 @@
5984
<c>true</c> if the accessibility button in the system's navigation area is
6085
available to the calling service, <c>false</c> otherwise</value>
6186
<remarks>
87+
<para>Retrieves whether the accessibility button in the system's navigation area is
88+
available to the calling service.</para>
89+
<para>&lt;strong&gt;Note:&lt;/strong&gt; If the service is not yet connected (e.g.
90+
<c>AccessibilityService#onServiceConnected()</c> has not yet been called) or the
91+
service has been disconnected, this method will have no effect and return <c>false</c>.</para>
6292
<para>
6393
<format type="text/html">
6494
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController#isAccessibilityButtonAvailable()" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.isAccessibilityButtonAvailable()</code>.</a>
@@ -118,6 +148,10 @@
118148
<AttributeName Language="C#">[Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)]</AttributeName>
119149
<AttributeName Language="F#">[&lt;Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)&gt;]</AttributeName>
120150
</Attribute>
151+
<Attribute>
152+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
153+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
154+
</Attribute>
121155
</Attributes>
122156
<ReturnValue>
123157
<ReturnType>System.Void</ReturnType>
@@ -158,6 +192,10 @@
158192
<AttributeName Language="C#">[Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;Landroid/os/Handler;)V", "", ApiSince=26)]</AttributeName>
159193
<AttributeName Language="F#">[&lt;Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;Landroid/os/Handler;)V", "", ApiSince=26)&gt;]</AttributeName>
160194
</Attribute>
195+
<Attribute>
196+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
197+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
198+
</Attribute>
161199
</Attributes>
162200
<ReturnValue>
163201
<ReturnType>System.Void</ReturnType>
@@ -262,6 +300,10 @@
262300
<AttributeName Language="C#">[Android.Runtime.Register("unregisterAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)]</AttributeName>
263301
<AttributeName Language="F#">[&lt;Android.Runtime.Register("unregisterAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)&gt;]</AttributeName>
264302
</Attribute>
303+
<Attribute>
304+
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
305+
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
306+
</Attribute>
265307
</Attributes>
266308
<ReturnValue>
267309
<ReturnType>System.Void</ReturnType>

0 commit comments

Comments
 (0)