This repository has been archived by the owner on May 1, 2024. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Add IsMainThread detection API * Add platform tests for main thread * Update docs and add more platform tests
- Loading branch information
1 parent
35a418e
commit 392fbee
Showing
17 changed files
with
357 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| using System.Threading.Tasks; | ||
| using Xamarin.Essentials; | ||
| using Xunit; | ||
|
|
||
| namespace DeviceTests | ||
| { | ||
| public class Platform_Tests | ||
| { | ||
| [Fact] | ||
| public Task IsOnMainThread() | ||
| { | ||
| return Utils.OnMainThread(() => | ||
| { | ||
| Assert.True(Platform.IsMainThread); | ||
| }); | ||
| } | ||
|
|
||
| [Fact] | ||
| public Task IsNotOnMainThread() | ||
| { | ||
| return Task.Run(() => | ||
| { | ||
| Assert.False(Platform.IsMainThread); | ||
| }); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| <Type Name="OrientationSensor" FullName="Xamarin.Essentials.OrientationSensor"> | ||
| <TypeSignature Language="C#" Value="public static class OrientationSensor" /> | ||
| <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit OrientationSensor extends System.Object" /> | ||
| <TypeSignature Language="DocId" Value="T:Xamarin.Essentials.OrientationSensor" /> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <Base> | ||
| <BaseTypeName>System.Object</BaseTypeName> | ||
| </Base> | ||
| <Interfaces /> | ||
| <Docs> | ||
| <summary>Device orientation (quaternion) relative to magnetic fields.</summary> | ||
| <remarks> | ||
| <para></para> | ||
| </remarks> | ||
| </Docs> | ||
| <Members> | ||
| <Member MemberName="IsMonitoring"> | ||
| <MemberSignature Language="C#" Value="public static bool IsMonitoring { get; }" /> | ||
| <MemberSignature Language="ILAsm" Value=".property bool IsMonitoring" /> | ||
| <MemberSignature Language="DocId" Value="P:Xamarin.Essentials.OrientationSensor.IsMonitoring" /> | ||
| <MemberType>Property</MemberType> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <ReturnValue> | ||
| <ReturnType>System.Boolean</ReturnType> | ||
| </ReturnValue> | ||
| <Docs> | ||
| <summary>Gets of currently monitoring the sensor.</summary> | ||
| <value>If monitoring.</value> | ||
| <remarks> | ||
| <para></para> | ||
| </remarks> | ||
| </Docs> | ||
| </Member> | ||
| <Member MemberName="ReadingChanged"> | ||
| <MemberSignature Language="C#" Value="public static event Xamarin.Essentials.OrientationSensorChangedEventHandler ReadingChanged;" /> | ||
| <MemberSignature Language="ILAsm" Value=".event class Xamarin.Essentials.OrientationSensorChangedEventHandler ReadingChanged" /> | ||
| <MemberSignature Language="DocId" Value="E:Xamarin.Essentials.OrientationSensor.ReadingChanged" /> | ||
| <MemberType>Event</MemberType> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <ReturnValue> | ||
| <ReturnType>Xamarin.Essentials.OrientationSensorChangedEventHandler</ReturnType> | ||
| </ReturnValue> | ||
| <Docs> | ||
| <summary> | ||
| <para>Event triggered when reading of sensor changes.</para> | ||
| </summary> | ||
| <remarks> | ||
| <para></para> | ||
| </remarks> | ||
| </Docs> | ||
| </Member> | ||
| <Member MemberName="Start"> | ||
| <MemberSignature Language="C#" Value="public static void Start (Xamarin.Essentials.SensorSpeed sensorSpeed);" /> | ||
| <MemberSignature Language="ILAsm" Value=".method public static hidebysig void Start(valuetype Xamarin.Essentials.SensorSpeed sensorSpeed) cil managed" /> | ||
| <MemberSignature Language="DocId" Value="M:Xamarin.Essentials.OrientationSensor.Start(Xamarin.Essentials.SensorSpeed)" /> | ||
| <MemberType>Method</MemberType> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <ReturnValue> | ||
| <ReturnType>System.Void</ReturnType> | ||
| </ReturnValue> | ||
| <Parameters> | ||
| <Parameter Name="sensorSpeed" Type="Xamarin.Essentials.SensorSpeed" /> | ||
| </Parameters> | ||
| <Docs> | ||
| <param name="sensorSpeed">Sensor speed to use.</param> | ||
| <summary>Starts monitoring orientation sensor with specific speed.</summary> | ||
| <remarks> | ||
| <para></para> | ||
| </remarks> | ||
| </Docs> | ||
| </Member> | ||
| <Member MemberName="Stop"> | ||
| <MemberSignature Language="C#" Value="public static void Stop ();" /> | ||
| <MemberSignature Language="ILAsm" Value=".method public static hidebysig void Stop() cil managed" /> | ||
| <MemberSignature Language="DocId" Value="M:Xamarin.Essentials.OrientationSensor.Stop" /> | ||
| <MemberType>Method</MemberType> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <ReturnValue> | ||
| <ReturnType>System.Void</ReturnType> | ||
| </ReturnValue> | ||
| <Parameters /> | ||
| <Docs> | ||
| <summary>Stops monitoring.</summary> | ||
| <remarks> | ||
| <para></para> | ||
| </remarks> | ||
| </Docs> | ||
| </Member> | ||
| </Members> | ||
| </Type> |
41 changes: 41 additions & 0 deletions
41
docs/en/Xamarin.Essentials/OrientationSensorChangedEventArgs.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| <Type Name="OrientationSensorChangedEventArgs" FullName="Xamarin.Essentials.OrientationSensorChangedEventArgs"> | ||
| <TypeSignature Language="C#" Value="public class OrientationSensorChangedEventArgs : EventArgs" /> | ||
| <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OrientationSensorChangedEventArgs extends System.EventArgs" /> | ||
| <TypeSignature Language="DocId" Value="T:Xamarin.Essentials.OrientationSensorChangedEventArgs" /> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <Base> | ||
| <BaseTypeName>System.EventArgs</BaseTypeName> | ||
| </Base> | ||
| <Interfaces /> | ||
| <Docs> | ||
| <summary>Orientation event args when reading changes.</summary> | ||
| <remarks> | ||
| <para></para> | ||
| </remarks> | ||
| </Docs> | ||
| <Members> | ||
| <Member MemberName="Reading"> | ||
| <MemberSignature Language="C#" Value="public Xamarin.Essentials.OrientationSensorData Reading { get; }" /> | ||
| <MemberSignature Language="ILAsm" Value=".property instance valuetype Xamarin.Essentials.OrientationSensorData Reading" /> | ||
| <MemberSignature Language="DocId" Value="P:Xamarin.Essentials.OrientationSensorChangedEventArgs.Reading" /> | ||
| <MemberType>Property</MemberType> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <ReturnValue> | ||
| <ReturnType>Xamarin.Essentials.OrientationSensorData</ReturnType> | ||
| </ReturnValue> | ||
| <Docs> | ||
| <summary>Gets the reading when it changes.</summary> | ||
| <value>The current Reading</value> | ||
| <remarks> | ||
| <para /> | ||
| </remarks> | ||
| </Docs> | ||
| </Member> | ||
| </Members> | ||
| </Type> |
25 changes: 25 additions & 0 deletions
25
docs/en/Xamarin.Essentials/OrientationSensorChangedEventHandler.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <Type Name="OrientationSensorChangedEventHandler" FullName="Xamarin.Essentials.OrientationSensorChangedEventHandler"> | ||
| <TypeSignature Language="C#" Value="public delegate void OrientationSensorChangedEventHandler(OrientationSensorChangedEventArgs e);" /> | ||
| <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed OrientationSensorChangedEventHandler extends System.MulticastDelegate" /> | ||
| <TypeSignature Language="DocId" Value="T:Xamarin.Essentials.OrientationSensorChangedEventHandler" /> | ||
| <AssemblyInfo> | ||
| <AssemblyName>Xamarin.Essentials</AssemblyName> | ||
| <AssemblyVersion>1.0.0.0</AssemblyVersion> | ||
| </AssemblyInfo> | ||
| <Base> | ||
| <BaseTypeName>System.Delegate</BaseTypeName> | ||
| </Base> | ||
| <Parameters> | ||
| <Parameter Name="e" Type="Xamarin.Essentials.OrientationSensorChangedEventArgs" /> | ||
| </Parameters> | ||
| <ReturnValue> | ||
| <ReturnType>System.Void</ReturnType> | ||
| </ReturnValue> | ||
| <Docs> | ||
| <param name="e">Event args.</param> | ||
| <summary>Event handler with reading.</summary> | ||
| <remarks> | ||
| <para /> | ||
| </remarks> | ||
| </Docs> | ||
| </Type> |
Oops, something went wrong.