-
Notifications
You must be signed in to change notification settings - Fork 3
/
IGeolocation.xml
241 lines (241 loc) · 16.8 KB
/
IGeolocation.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
239
240
241
<Type Name="IGeolocation" FullName="Microsoft.Maui.Devices.Sensors.IGeolocation">
<TypeSignature Language="C#" Value="public interface IGeolocation" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IGeolocation" />
<TypeSignature Language="DocId" Value="T:Microsoft.Maui.Devices.Sensors.IGeolocation" />
<TypeSignature Language="VB.NET" Value="Public Interface IGeolocation" />
<TypeSignature Language="C++ CLI" Value="public interface class IGeolocation" />
<TypeSignature Language="F#" Value="type IGeolocation = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides a way to get the current location of the device.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetLastKnownLocationAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Maui.Devices.Sensors.Location?> GetLastKnownLocationAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Maui.Devices.Sensors.Location> GetLastKnownLocationAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Devices.Sensors.IGeolocation.GetLastKnownLocationAsync" />
<MemberSignature Language="VB.NET" Value="Public Function GetLastKnownLocationAsync () As Task(Of Location)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<Microsoft::Maui::Devices::Sensors::Location ^> ^ GetLastKnownLocationAsync();" />
<MemberSignature Language="F#" Value="abstract member GetLastKnownLocationAsync : unit -> System.Threading.Tasks.Task<Microsoft.Maui.Devices.Sensors.Location>" Usage="iGeolocation.GetLastKnownLocationAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Maui.Devices.Sensors.Location></ReturnType>
<Attributes>
<Attribute FrameworkAlternate="net-maui-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the last known location of the device.
</summary>
<returns>A <see cref="T:Microsoft.Maui.Devices.Sensors.Location" /> object containing recent location information or <see langword="null" /> if no location is known.</returns>
<remarks>
<para>The location permissions will be requested at runtime if needed. You might still need to declare something in your app manifest.</para>
<para>This location may be a recently cached location.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetLocationAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Maui.Devices.Sensors.Location?> GetLocationAsync (Microsoft.Maui.Devices.Sensors.GeolocationRequest request, System.Threading.CancellationToken cancelToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Maui.Devices.Sensors.Location> GetLocationAsync(class Microsoft.Maui.Devices.Sensors.GeolocationRequest request, valuetype System.Threading.CancellationToken cancelToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Devices.Sensors.IGeolocation.GetLocationAsync(Microsoft.Maui.Devices.Sensors.GeolocationRequest,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetLocationAsync (request As GeolocationRequest, cancelToken As CancellationToken) As Task(Of Location)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<Microsoft::Maui::Devices::Sensors::Location ^> ^ GetLocationAsync(Microsoft::Maui::Devices::Sensors::GeolocationRequest ^ request, System::Threading::CancellationToken cancelToken);" />
<MemberSignature Language="F#" Value="abstract member GetLocationAsync : Microsoft.Maui.Devices.Sensors.GeolocationRequest * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Maui.Devices.Sensors.Location>" Usage="iGeolocation.GetLocationAsync (request, cancelToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Maui.Devices.Sensors.Location></ReturnType>
<Attributes>
<Attribute FrameworkAlternate="net-maui-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="Microsoft.Maui.Devices.Sensors.GeolocationRequest" />
<Parameter Name="cancelToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="request">The criteria to use when determining the location of the device.</param>
<param name="cancelToken">A token that can be used for cancelling the operation.</param>
<summary>
Returns the current location of the device.
</summary>
<returns>A <see cref="T:Microsoft.Maui.Devices.Sensors.Location" /> object containing current location information or <see langword="null" /> if no location could be determined.</returns>
<remarks>The location permissions will be requested at runtime if needed. You might still need to declare something in your app manifest.</remarks>
</Docs>
</Member>
<Member MemberName="IsListeningForeground">
<MemberSignature Language="C#" Value="public bool IsListeningForeground { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsListeningForeground" />
<MemberSignature Language="DocId" Value="P:Microsoft.Maui.Devices.Sensors.IGeolocation.IsListeningForeground" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsListeningForeground As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsListeningForeground { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsListeningForeground : bool" Usage="Microsoft.Maui.Devices.Sensors.IGeolocation.IsListeningForeground" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates if currently listening to location updates while the app is in foreground.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListeningFailed">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationListeningFailedEventArgs>? ListeningFailed;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Maui.Devices.Sensors.GeolocationListeningFailedEventArgs> ListeningFailed" />
<MemberSignature Language="DocId" Value="E:Microsoft.Maui.Devices.Sensors.IGeolocation.ListeningFailed" />
<MemberSignature Language="VB.NET" Value="Event ListeningFailed As EventHandler(Of GeolocationListeningFailedEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler<Microsoft::Maui::Devices::Sensors::GeolocationListeningFailedEventArgs ^> ^ ListeningFailed;" />
<MemberSignature Language="F#" Value="member this.ListeningFailed : EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationListeningFailedEventArgs> " Usage="member this.ListeningFailed : System.EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationListeningFailedEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationListeningFailedEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>
Occurs when an error during listening for location updates arises. When the event is
fired, listening for further location updates has been stopped and no further
<see cref="E:Microsoft.Maui.Devices.Sensors.IGeolocation.LocationChanged" /> events are sent.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LocationChanged">
<MemberSignature Language="C#" Value="event EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationLocationChangedEventArgs>? LocationChanged;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler`1<class Microsoft.Maui.Devices.Sensors.GeolocationLocationChangedEventArgs> LocationChanged" />
<MemberSignature Language="DocId" Value="E:Microsoft.Maui.Devices.Sensors.IGeolocation.LocationChanged" />
<MemberSignature Language="VB.NET" Value="Event LocationChanged As EventHandler(Of GeolocationLocationChangedEventArgs) " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler<Microsoft::Maui::Devices::Sensors::GeolocationLocationChangedEventArgs ^> ^ LocationChanged;" />
<MemberSignature Language="F#" Value="member this.LocationChanged : EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationLocationChangedEventArgs> " Usage="member this.LocationChanged : System.EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationLocationChangedEventArgs> " />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.EventHandler<Microsoft.Maui.Devices.Sensors.GeolocationLocationChangedEventArgs></ReturnType>
</ReturnValue>
<Docs>
<summary>
Occurs while listening to location updates.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartListeningForegroundAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> StartListeningForegroundAsync (Microsoft.Maui.Devices.Sensors.GeolocationListeningRequest request);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> StartListeningForegroundAsync(class Microsoft.Maui.Devices.Sensors.GeolocationListeningRequest request) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Devices.Sensors.IGeolocation.StartListeningForegroundAsync(Microsoft.Maui.Devices.Sensors.GeolocationListeningRequest)" />
<MemberSignature Language="VB.NET" Value="Public Function StartListeningForegroundAsync (request As GeolocationListeningRequest) As Task(Of Boolean)" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Threading::Tasks::Task<bool> ^ StartListeningForegroundAsync(Microsoft::Maui::Devices::Sensors::GeolocationListeningRequest ^ request);" />
<MemberSignature Language="F#" Value="abstract member StartListeningForegroundAsync : Microsoft.Maui.Devices.Sensors.GeolocationListeningRequest -> System.Threading.Tasks.Task<bool>" Usage="iGeolocation.StartListeningForegroundAsync request" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="request" Type="Microsoft.Maui.Devices.Sensors.GeolocationListeningRequest" />
</Parameters>
<Docs>
<param name="request">The listening request parameters to use.</param>
<summary>
Starts listening to location updates using the <see cref="E:Microsoft.Maui.Devices.Sensors.IGeolocation.LocationChanged" /> event. Events
may only sent when the app is in the foreground. Requests
<see cref="T:Microsoft.Maui.ApplicationModel.Permissions.LocationWhenInUse" /> from the user.
</summary>
<returns>
<see langword="true" /> when listening was started, or <see langword="false" /> when listening couldn't be started.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown when <paramref name="request" /> is <see langword="null" />.</exception>
<exception cref="T:Microsoft.Maui.ApplicationModel.FeatureNotSupportedException">Thrown if listening is not supported on this platform.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if already listening and <see cref="P:Microsoft.Maui.Devices.Sensors.IGeolocation.IsListeningForeground" /> returns <see langword="true" />.</exception>
</Docs>
</Member>
<Member MemberName="StopListeningForeground">
<MemberSignature Language="C#" Value="public void StopListeningForeground ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void StopListeningForeground() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Maui.Devices.Sensors.IGeolocation.StopListeningForeground" />
<MemberSignature Language="VB.NET" Value="Public Sub StopListeningForeground ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void StopListeningForeground();" />
<MemberSignature Language="F#" Value="abstract member StopListeningForeground : unit -> unit" Usage="iGeolocation.StopListeningForeground " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Maui.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Stop listening for location updates when the app is in the foreground.
Has no effect when <see cref="P:Microsoft.Maui.Devices.Sensors.IGeolocation.IsListeningForeground" /> is currently <see langword="false" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>