/
IOnBackInvokedDispatcher.xml
238 lines (236 loc) · 16.5 KB
/
IOnBackInvokedDispatcher.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
<Type Name="IOnBackInvokedDispatcher" FullName="Android.Window.IOnBackInvokedDispatcher">
<TypeSignature Language="C#" Value="public interface IOnBackInvokedDispatcher : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IOnBackInvokedDispatcher implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Android.Window.IOnBackInvokedDispatcher" />
<TypeSignature Language="F#" Value="type IOnBackInvokedDispatcher = interface
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("android/window/OnBackInvokedDispatcher", "", "Android.Window.IOnBackInvokedDispatcherInvoker", ApiSince=33)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("android/window/OnBackInvokedDispatcher", "", "Android.Window.IOnBackInvokedDispatcherInvoker", ApiSince=33)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Dispatcher to register <c>OnBackInvokedCallback</c> instances for handling
back invocations.</summary>
<remarks>
<para>Dispatcher to register <c>OnBackInvokedCallback</c> instances for handling
back invocations.
It also provides interfaces to update the attributes of <c>OnBackInvokedCallback</c>.
Attribute updates are proactively pushed to the window manager if they change the dispatch
target (a.k.a. the callback to be invoked next), or its behavior.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/window/OnBackInvokedDispatcher" title="Reference documentation">Java documentation for <code>android.window.OnBackInvokedDispatcher</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>
<Members>
<Member MemberName="PriorityDefault">
<MemberSignature Language="C#" Value="public const int PriorityDefault = 0;" />
<MemberSignature Language="ILAsm" Value=".field public static literal int32 PriorityDefault = (0)" />
<MemberSignature Language="DocId" Value="F:Android.Window.IOnBackInvokedDispatcher.PriorityDefault" />
<MemberSignature Language="F#" Value="val mutable PriorityDefault : int" Usage="Android.Window.IOnBackInvokedDispatcher.PriorityDefault" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("PRIORITY_DEFAULT", ApiSince=33)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("PRIORITY_DEFAULT", ApiSince=33)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android33.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android33.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Default priority level of <c>OnBackInvokedCallback</c>s.</summary>
<remarks>
<para>Default priority level of <c>OnBackInvokedCallback</c>s.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/window/OnBackInvokedDispatcher#PRIORITY_DEFAULT" title="Reference documentation">Java documentation for <code>android.window.OnBackInvokedDispatcher.PRIORITY_DEFAULT</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="PriorityOverlay">
<MemberSignature Language="C#" Value="public const int PriorityOverlay = 1000000;" />
<MemberSignature Language="ILAsm" Value=".field public static literal int32 PriorityOverlay = (1000000)" />
<MemberSignature Language="DocId" Value="F:Android.Window.IOnBackInvokedDispatcher.PriorityOverlay" />
<MemberSignature Language="F#" Value="val mutable PriorityOverlay : int" Usage="Android.Window.IOnBackInvokedDispatcher.PriorityOverlay" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("PRIORITY_OVERLAY", ApiSince=33)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("PRIORITY_OVERLAY", ApiSince=33)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android33.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android33.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<MemberValue>1000000</MemberValue>
<Docs>
<summary>Priority level of <c>OnBackInvokedCallback</c>s for overlays such as menus and
navigation drawers that should receive back dispatch before non-overlays.</summary>
<remarks>
<para>Priority level of <c>OnBackInvokedCallback</c>s for overlays such as menus and
navigation drawers that should receive back dispatch before non-overlays.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/window/OnBackInvokedDispatcher#PRIORITY_OVERLAY" title="Reference documentation">Java documentation for <code>android.window.OnBackInvokedDispatcher.PRIORITY_OVERLAY</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="RegisterOnBackInvokedCallback">
<MemberSignature Language="C#" Value="public void RegisterOnBackInvokedCallback (int priority, Android.Window.IOnBackInvokedCallback callback);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RegisterOnBackInvokedCallback(int32 priority, class Android.Window.IOnBackInvokedCallback callback) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Window.IOnBackInvokedDispatcher.RegisterOnBackInvokedCallback(System.Int32,Android.Window.IOnBackInvokedCallback)" />
<MemberSignature Language="F#" Value="abstract member RegisterOnBackInvokedCallback : int * Android.Window.IOnBackInvokedCallback -> unit" Usage="iOnBackInvokedDispatcher.RegisterOnBackInvokedCallback (priority, callback)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("registerOnBackInvokedCallback", "(ILandroid/window/OnBackInvokedCallback;)V", "GetRegisterOnBackInvokedCallback_ILandroid_window_OnBackInvokedCallback_Handler:Android.Window.IOnBackInvokedDispatcherInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=33)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("registerOnBackInvokedCallback", "(ILandroid/window/OnBackInvokedCallback;)V", "GetRegisterOnBackInvokedCallback_ILandroid_window_OnBackInvokedCallback_Handler:Android.Window.IOnBackInvokedDispatcherInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=33)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android33.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android33.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="priority" Type="System.Int32">
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.IntDef(Fields=new System.String[] { "PriorityDefault", "PriorityOverlay" }, Type="Android.Window.IOnBackInvokedDispatcher")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.IntDef(Fields=new System.String[] { "PriorityDefault", "PriorityOverlay" }, Type="Android.Window.IOnBackInvokedDispatcher")>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="callback" Type="Android.Window.IOnBackInvokedCallback" />
</Parameters>
<Docs>
<param name="priority">The priority of the callback.</param>
<param name="callback">The callback to be registered. If the callback instance has been already
registered, the existing instance (no matter its priority) will be
unregistered and registered again.</param>
<summary>Registers a <c>OnBackInvokedCallback</c>.</summary>
<remarks>
<para>Registers a <c>OnBackInvokedCallback</c>.
Within the same priority level, callbacks are invoked in the reverse order in which
they are registered. Higher priority callbacks are invoked before lower priority ones.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/window/OnBackInvokedDispatcher#registerOnBackInvokedCallback(int,%20android.window.OnBackInvokedCallback)" title="Reference documentation">Java documentation for <code>android.window.OnBackInvokedDispatcher.registerOnBackInvokedCallback(int, android.window.OnBackInvokedCallback)</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="UnregisterOnBackInvokedCallback">
<MemberSignature Language="C#" Value="public void UnregisterOnBackInvokedCallback (Android.Window.IOnBackInvokedCallback callback);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void UnregisterOnBackInvokedCallback(class Android.Window.IOnBackInvokedCallback callback) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Window.IOnBackInvokedDispatcher.UnregisterOnBackInvokedCallback(Android.Window.IOnBackInvokedCallback)" />
<MemberSignature Language="F#" Value="abstract member UnregisterOnBackInvokedCallback : Android.Window.IOnBackInvokedCallback -> unit" Usage="iOnBackInvokedDispatcher.UnregisterOnBackInvokedCallback callback" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("unregisterOnBackInvokedCallback", "(Landroid/window/OnBackInvokedCallback;)V", "GetUnregisterOnBackInvokedCallback_Landroid_window_OnBackInvokedCallback_Handler:Android.Window.IOnBackInvokedDispatcherInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=33)]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("unregisterOnBackInvokedCallback", "(Landroid/window/OnBackInvokedCallback;)V", "GetUnregisterOnBackInvokedCallback_Landroid_window_OnBackInvokedCallback_Handler:Android.Window.IOnBackInvokedDispatcherInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=33)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android33.0")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.SupportedOSPlatform("android33.0")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="Android.Window.IOnBackInvokedCallback" />
</Parameters>
<Docs>
<param name="callback">The callback to be unregistered. Does nothing if the callback has not been
registered.</param>
<summary>Unregisters a <c>OnBackInvokedCallback</c>.</summary>
<remarks>
<para>Unregisters a <c>OnBackInvokedCallback</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/window/OnBackInvokedDispatcher#unregisterOnBackInvokedCallback(android.window.OnBackInvokedCallback)" title="Reference documentation">Java documentation for <code>android.window.OnBackInvokedDispatcher.unregisterOnBackInvokedCallback(android.window.OnBackInvokedCallback)</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>
</Members>
</Type>