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

Commit

Permalink
Udated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Schilli, Niklas committed Nov 10, 2018
1 parent 4597129 commit 4c721d3
Show file tree
Hide file tree
Showing 7 changed files with 170 additions and 20 deletions.
21 changes: 16 additions & 5 deletions docs/en/FrameworksIndex/xamarin-essentials-android.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<Framework Name="xamarin-essentials-android">
<Assemblies>
<Assembly Name="Xamarin.Essentials" Version="1.0.0.0" />
</Assemblies>
<Namespace Name="Xamarin.Essentials">
<Type Name="Xamarin.Essentials.Accelerometer" Id="T:Xamarin.Essentials.Accelerometer">
<Member Id="E:Xamarin.Essentials.Accelerometer.ReadingChanged" />
Expand Down Expand Up @@ -117,17 +120,13 @@
<Member Id="E:Xamarin.Essentials.Connectivity.ConnectivityChanged" />
<Member Id="P:Xamarin.Essentials.Connectivity.NetworkAccess" />
<Member Id="P:Xamarin.Essentials.Connectivity.Profiles" />
<Member Id="P:Xamarin.Essentials.Connectivity.WiFiSignalStrength" />
</Type>
<Type Name="Xamarin.Essentials.ConnectivityChangedEventArgs" Id="T:Xamarin.Essentials.ConnectivityChangedEventArgs">
<Member Id="M:Xamarin.Essentials.ConnectivityChangedEventArgs.ToString" />
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.NetworkAccess" />
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.Profiles" />
</Type>
<Type Name="Xamarin.Essentials.Share" Id="T:Xamarin.Essentials.Share">
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(Xamarin.Essentials.ShareTextRequest)" />
</Type>
<Type Name="Xamarin.Essentials.DeviceDisplay" Id="T:Xamarin.Essentials.DeviceDisplay">
<Member Id="E:Xamarin.Essentials.DeviceDisplay.ScreenMetricsChanged" />
<Member Id="P:Xamarin.Essentials.DeviceDisplay.ScreenMetrics" />
Expand Down Expand Up @@ -479,6 +478,11 @@
<Member Id="F:Xamarin.Essentials.SensorSpeed.Normal" />
<Member Id="F:Xamarin.Essentials.SensorSpeed.UI" />
</Type>
<Type Name="Xamarin.Essentials.Share" Id="T:Xamarin.Essentials.Share">
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(Xamarin.Essentials.ShareTextRequest)" />
</Type>
<Type Name="Xamarin.Essentials.ShareTextRequest" Id="T:Xamarin.Essentials.ShareTextRequest">
<Member Id="M:Xamarin.Essentials.ShareTextRequest.#ctor" />
<Member Id="M:Xamarin.Essentials.ShareTextRequest.#ctor(System.String)" />
Expand All @@ -488,6 +492,13 @@
<Member Id="P:Xamarin.Essentials.ShareTextRequest.Title" />
<Member Id="P:Xamarin.Essentials.ShareTextRequest.Uri" />
</Type>
<Type Name="Xamarin.Essentials.SignalStrength" Id="T:Xamarin.Essentials.SignalStrength">
<Member Id="F:Xamarin.Essentials.SignalStrength.Fair" />
<Member Id="F:Xamarin.Essentials.SignalStrength.None" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Strong" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Unknown" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Weak" />
</Type>
<Type Name="Xamarin.Essentials.Sms" Id="T:Xamarin.Essentials.Sms">
<Member Id="M:Xamarin.Essentials.Sms.ComposeAsync" />
<Member Id="M:Xamarin.Essentials.Sms.ComposeAsync(Xamarin.Essentials.SmsMessage)" />
Expand Down
18 changes: 13 additions & 5 deletions docs/en/FrameworksIndex/xamarin-essentials-ios.xml
Original file line number Diff line number Diff line change
Expand Up @@ -118,17 +118,13 @@
<Member Id="E:Xamarin.Essentials.Connectivity.ConnectivityChanged" />
<Member Id="P:Xamarin.Essentials.Connectivity.NetworkAccess" />
<Member Id="P:Xamarin.Essentials.Connectivity.Profiles" />
<Member Id="P:Xamarin.Essentials.Connectivity.WiFiSignalStrength" />
</Type>
<Type Name="Xamarin.Essentials.ConnectivityChangedEventArgs" Id="T:Xamarin.Essentials.ConnectivityChangedEventArgs">
<Member Id="M:Xamarin.Essentials.ConnectivityChangedEventArgs.ToString" />
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.NetworkAccess" />
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.Profiles" />
</Type>
<Type Name="Xamarin.Essentials.Share" Id="T:Xamarin.Essentials.Share">
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(Xamarin.Essentials.ShareTextRequest)" />
</Type>
<Type Name="Xamarin.Essentials.DeviceDisplay" Id="T:Xamarin.Essentials.DeviceDisplay">
<Member Id="E:Xamarin.Essentials.DeviceDisplay.ScreenMetricsChanged" />
<Member Id="P:Xamarin.Essentials.DeviceDisplay.ScreenMetrics" />
Expand Down Expand Up @@ -478,6 +474,11 @@
<Member Id="F:Xamarin.Essentials.SensorSpeed.Normal" />
<Member Id="F:Xamarin.Essentials.SensorSpeed.UI" />
</Type>
<Type Name="Xamarin.Essentials.Share" Id="T:Xamarin.Essentials.Share">
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(Xamarin.Essentials.ShareTextRequest)" />
</Type>
<Type Name="Xamarin.Essentials.ShareTextRequest" Id="T:Xamarin.Essentials.ShareTextRequest">
<Member Id="M:Xamarin.Essentials.ShareTextRequest.#ctor" />
<Member Id="M:Xamarin.Essentials.ShareTextRequest.#ctor(System.String)" />
Expand All @@ -487,6 +488,13 @@
<Member Id="P:Xamarin.Essentials.ShareTextRequest.Title" />
<Member Id="P:Xamarin.Essentials.ShareTextRequest.Uri" />
</Type>
<Type Name="Xamarin.Essentials.SignalStrength" Id="T:Xamarin.Essentials.SignalStrength">
<Member Id="F:Xamarin.Essentials.SignalStrength.Fair" />
<Member Id="F:Xamarin.Essentials.SignalStrength.None" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Strong" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Unknown" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Weak" />
</Type>
<Type Name="Xamarin.Essentials.Sms" Id="T:Xamarin.Essentials.Sms">
<Member Id="M:Xamarin.Essentials.Sms.ComposeAsync" />
<Member Id="M:Xamarin.Essentials.Sms.ComposeAsync(Xamarin.Essentials.SmsMessage)" />
Expand Down
1 change: 0 additions & 1 deletion docs/en/FrameworksIndex/xamarin-essentials-uwp.xml
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.NetworkAccess" />
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.Profiles" />
</Type>
<Type Name="Xamarin.Essentials.Share" Id="T:Xamarin.Essentials.Share">
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(Xamarin.Essentials.ShareTextRequest)" />
Expand Down
21 changes: 16 additions & 5 deletions docs/en/FrameworksIndex/xamarin-essentials.xml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
<Framework Name="xamarin-essentials">
<Assemblies>
<Assembly Name="Xamarin.Essentials" Version="1.0.0.0" />
</Assemblies>
<Namespace Name="Xamarin.Essentials">
<Type Name="Xamarin.Essentials.Accelerometer" Id="T:Xamarin.Essentials.Accelerometer">
<Member Id="E:Xamarin.Essentials.Accelerometer.ReadingChanged" />
Expand Down Expand Up @@ -117,17 +120,13 @@
<Member Id="E:Xamarin.Essentials.Connectivity.ConnectivityChanged" />
<Member Id="P:Xamarin.Essentials.Connectivity.NetworkAccess" />
<Member Id="P:Xamarin.Essentials.Connectivity.Profiles" />
<Member Id="P:Xamarin.Essentials.Connectivity.WiFiSignalStrength" />
</Type>
<Type Name="Xamarin.Essentials.ConnectivityChangedEventArgs" Id="T:Xamarin.Essentials.ConnectivityChangedEventArgs">
<Member Id="M:Xamarin.Essentials.ConnectivityChangedEventArgs.ToString" />
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.NetworkAccess" />
<Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.Profiles" />
</Type>
<Type Name="Xamarin.Essentials.Share" Id="T:Xamarin.Essentials.Share">
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(Xamarin.Essentials.ShareTextRequest)" />
</Type>
<Type Name="Xamarin.Essentials.DeviceDisplay" Id="T:Xamarin.Essentials.DeviceDisplay">
<Member Id="E:Xamarin.Essentials.DeviceDisplay.ScreenMetricsChanged" />
<Member Id="P:Xamarin.Essentials.DeviceDisplay.ScreenMetrics" />
Expand Down Expand Up @@ -475,6 +474,11 @@
<Member Id="F:Xamarin.Essentials.SensorSpeed.Normal" />
<Member Id="F:Xamarin.Essentials.SensorSpeed.UI" />
</Type>
<Type Name="Xamarin.Essentials.Share" Id="T:Xamarin.Essentials.Share">
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.Share.RequestAsync(Xamarin.Essentials.ShareTextRequest)" />
</Type>
<Type Name="Xamarin.Essentials.ShareTextRequest" Id="T:Xamarin.Essentials.ShareTextRequest">
<Member Id="M:Xamarin.Essentials.ShareTextRequest.#ctor" />
<Member Id="M:Xamarin.Essentials.ShareTextRequest.#ctor(System.String)" />
Expand All @@ -484,6 +488,13 @@
<Member Id="P:Xamarin.Essentials.ShareTextRequest.Title" />
<Member Id="P:Xamarin.Essentials.ShareTextRequest.Uri" />
</Type>
<Type Name="Xamarin.Essentials.SignalStrength" Id="T:Xamarin.Essentials.SignalStrength">
<Member Id="F:Xamarin.Essentials.SignalStrength.Fair" />
<Member Id="F:Xamarin.Essentials.SignalStrength.None" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Strong" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Unknown" />
<Member Id="F:Xamarin.Essentials.SignalStrength.Weak" />
</Type>
<Type Name="Xamarin.Essentials.Sms" Id="T:Xamarin.Essentials.Sms">
<Member Id="M:Xamarin.Essentials.Sms.ComposeAsync" />
<Member Id="M:Xamarin.Essentials.Sms.ComposeAsync(Xamarin.Essentials.SmsMessage)" />
Expand Down
18 changes: 18 additions & 0 deletions docs/en/Xamarin.Essentials/Connectivity.xml
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,23 @@
</remarks>
</Docs>
</Member>
<Member MemberName="WiFiSignalStrength">
<MemberSignature Language="C#" Value="public static Xamarin.Essentials.SignalStrength WiFiSignalStrength { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype Xamarin.Essentials.SignalStrength WiFiSignalStrength" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.Connectivity.WiFiSignalStrength" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.SignalStrength</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the signal strength for wifi network if it is available.</summary>
<value>Unknown if connectivity can not be determined, None if no connection is present. Otherwise a value between Fair and High.</value>
<remarks>Unknown and None have different causes. Remember to test against both in conditions where you want to display a signal strength.</remarks>
</Docs>
</Member>
</Members>
</Type>
102 changes: 102 additions & 0 deletions docs/en/Xamarin.Essentials/SignalStrength.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<Type Name="SignalStrength" FullName="Xamarin.Essentials.SignalStrength">
<TypeSignature Language="C#" Value="public enum SignalStrength" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SignalStrength extends System.Enum" />
<TypeSignature Language="DocId" Value="T:Xamarin.Essentials.SignalStrength" />
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Wifi signal strength</summary>
</Docs>
<Members>
<Member MemberName="Fair">
<MemberSignature Language="C#" Value="Fair" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.SignalStrength Fair = int32(3)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.SignalStrength.Fair" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.SignalStrength</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Medium signal strength</summary>
</Docs>
</Member>
<Member MemberName="None">
<MemberSignature Language="C#" Value="None" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.SignalStrength None = int32(1)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.SignalStrength.None" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.SignalStrength</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>No wifi signal connected or available.</summary>
</Docs>
</Member>
<Member MemberName="Strong">
<MemberSignature Language="C#" Value="Strong" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.SignalStrength Strong = int32(4)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.SignalStrength.Strong" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.SignalStrength</ReturnType>
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>High signal strength</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
<MemberSignature Language="C#" Value="Unknown" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.SignalStrength Unknown = int32(0)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.SignalStrength.Unknown" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.SignalStrength</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Signal strength was unable to be determined.</summary>
</Docs>
</Member>
<Member MemberName="Weak">
<MemberSignature Language="C#" Value="Weak" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype Xamarin.Essentials.SignalStrength Weak = int32(2)" />
<MemberSignature Language="DocId" Value="F:Xamarin.Essentials.SignalStrength.Weak" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Xamarin.Essentials.SignalStrength</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Low signal strength.</summary>
</Docs>
</Member>
</Members>
</Type>
9 changes: 5 additions & 4 deletions docs/en/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,6 @@
<Attribute FrameworkAlternate="xamarin-essentials">
<AttributeName>System.Runtime.Versioning.TargetFramework(".NETStandard,Version=v2.0", FrameworkDisplayName="")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyInformationalVersion("1.0.0+8db259fd337f910db5b9158f8ab6b5cdbb783499")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.CompilerServices.InternalsVisibleTo("XamarinEssentialsDeviceTestsShared")</AttributeName>
</Attribute>
Expand Down Expand Up @@ -80,6 +77,9 @@
<Attribute FrameworkAlternate="xamarin-essentials-uwp">
<AttributeName>System.Runtime.Versioning.TargetFramework(".NETCore,Version=v5.0", FrameworkDisplayName=".NET for Windows Universal")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyInformationalVersion("1.0.0+4597129abddc3142761e42035060f412da5fcb01")</AttributeName>
</Attribute>
</Attributes>
</Assembly>
</Assemblies>
Expand Down Expand Up @@ -107,7 +107,6 @@
<Type Name="ConnectionProfile" Kind="Enumeration" />
<Type Name="Connectivity" Kind="Class" />
<Type Name="ConnectivityChangedEventArgs" Kind="Class" />
<Type Name="Share" Kind="Class" />
<Type Name="DeviceDisplay" Kind="Class" />
<Type Name="DeviceInfo" Kind="Class" />
<Type Name="DeviceInfo+Idioms" Kind="Class" />
Expand Down Expand Up @@ -160,7 +159,9 @@
<Type Name="ScreenRotation" Kind="Enumeration" />
<Type Name="SecureStorage" Kind="Class" />
<Type Name="SensorSpeed" Kind="Enumeration" />
<Type Name="Share" Kind="Class" />
<Type Name="ShareTextRequest" Kind="Class" />
<Type Name="SignalStrength" Kind="Enumeration" />
<Type Name="Sms" Kind="Class" />
<Type Name="SmsMessage" Kind="Class" />
<Type Name="SpeakSettings" Kind="Class" />
Expand Down

0 comments on commit 4c721d3

Please sign in to comment.