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

Update the docs with the latest APIs #233

Merged
merged 4 commits into from
May 12, 2018
Merged

Update the docs with the latest APIs #233

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e2ee8dc
Update the docs with the latest APIs
mattleibow May 8, 2018
7b6efde
Add docs for SecAccessible
jamesmontemagno May 11, 2018
cb116ce
Merge branch 'master' into feature/update-docs
jamesmontemagno May 11, 2018
226c361
Update SecureStorage.xml
mattleibow May 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/FrameworksIndex/xamarin-essentials-android.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@
</Type>
<Type Name="Xamarin.Essentials.Locale" Id="T:Xamarin.Essentials.Locale">
<Member Id="P:Xamarin.Essentials.Locale.Country" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
<Member Id="P:Xamarin.Essentials.Locale.Language" />
<Member Id="P:Xamarin.Essentials.Locale.Name" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
</Type>
<Type Name="Xamarin.Essentials.Location" Id="T:Xamarin.Essentials.Location">
<Member Id="M:Xamarin.Essentials.Location.#ctor" />
Expand Down
5 changes: 4 additions & 1 deletion docs/en/FrameworksIndex/xamarin-essentials-ios.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@
</Type>
<Type Name="Xamarin.Essentials.Locale" Id="T:Xamarin.Essentials.Locale">
<Member Id="P:Xamarin.Essentials.Locale.Country" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
<Member Id="P:Xamarin.Essentials.Locale.Language" />
<Member Id="P:Xamarin.Essentials.Locale.Name" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
</Type>
<Type Name="Xamarin.Essentials.Location" Id="T:Xamarin.Essentials.Location">
<Member Id="M:Xamarin.Essentials.Location.#ctor" />
Expand Down Expand Up @@ -337,7 +337,10 @@
</Type>
<Type Name="Xamarin.Essentials.SecureStorage" Id="T:Xamarin.Essentials.SecureStorage">
<Member Id="M:Xamarin.Essentials.SecureStorage.GetAsync(System.String)" />
<Member Id="M:Xamarin.Essentials.SecureStorage.GetAsync(System.String,Security.SecAccessible)" />
<Member Id="M:Xamarin.Essentials.SecureStorage.SetAsync(System.String,System.String)" />
<Member Id="M:Xamarin.Essentials.SecureStorage.SetAsync(System.String,System.String,Security.SecAccessible)" />
<Member Id="P:Xamarin.Essentials.SecureStorage.DefaultAccessible" />
</Type>
<Type Name="Xamarin.Essentials.SensorSpeed" Id="T:Xamarin.Essentials.SensorSpeed">
<Member Id="F:Xamarin.Essentials.SensorSpeed.Fastest" />
Expand Down
2 changes: 1 addition & 1 deletion docs/en/FrameworksIndex/xamarin-essentials-uwp.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@
</Type>
<Type Name="Xamarin.Essentials.Locale" Id="T:Xamarin.Essentials.Locale">
<Member Id="P:Xamarin.Essentials.Locale.Country" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
<Member Id="P:Xamarin.Essentials.Locale.Language" />
<Member Id="P:Xamarin.Essentials.Locale.Name" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
</Type>
<Type Name="Xamarin.Essentials.Location" Id="T:Xamarin.Essentials.Location">
<Member Id="M:Xamarin.Essentials.Location.#ctor" />
Expand Down
2 changes: 1 addition & 1 deletion docs/en/FrameworksIndex/xamarin-essentials.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@
</Type>
<Type Name="Xamarin.Essentials.Locale" Id="T:Xamarin.Essentials.Locale">
<Member Id="P:Xamarin.Essentials.Locale.Country" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
<Member Id="P:Xamarin.Essentials.Locale.Language" />
<Member Id="P:Xamarin.Essentials.Locale.Name" />
<Member Id="P:Xamarin.Essentials.Locale.Id" />
</Type>
<Type Name="Xamarin.Essentials.Location" Id="T:Xamarin.Essentials.Location">
<Member Id="M:Xamarin.Essentials.Location.#ctor" />
Expand Down
34 changes: 17 additions & 17 deletions docs/en/Xamarin.Essentials/Locale.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@
<remarks>This value may vary between platforms.</remarks>
</Docs>
</Member>
<Member MemberName="Language">
<MemberSignature Language="C#" Value="public string Language { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Language" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.Locale.Language" />
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.Locale.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
Expand All @@ -46,15 +46,15 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Language name or code.</summary>
<summary>Unique Id of the Locale.</summary>
<value></value>
<remarks>This value may vary between platforms.</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.Locale.Name" />
<Member MemberName="Language">
<MemberSignature Language="C#" Value="public string Language { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Language" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.Locale.Language" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
Expand All @@ -64,15 +64,15 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Display name of the Locale.</summary>
<summary>Language name or code.</summary>
<value></value>
<remarks></remarks>
<remarks>This value may vary between platforms.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.Locale.Id" />
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.Locale.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
Expand All @@ -82,7 +82,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Unique Id of the Locale.</summary>
<summary>Display name of the Locale.</summary>
<value></value>
<remarks></remarks>
</Docs>
Expand Down
88 changes: 84 additions & 4 deletions docs/en/Xamarin.Essentials/SecureStorage.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<para>Each platform uses the platform provided native API's for storing data securely:</para>
<list type="bullet">
<item>
<term>iOS: Data is stored in KeyChain.</term>
<term>iOS: Data is stored in KeyChain. Additional information on SecAccessible at: <see cref="https://developer.xamarin.com/api/type/Security.SecAccessible/" /></term>
</item>
<item>
<term>Android: Encryption keys are stored in KeyStore and encrypted data is stored in a named shared preference container (PackageId.Xamarin.Essentials).</term>
Expand All @@ -29,6 +29,24 @@
</remarks>
</Docs>
<Members>
<Member MemberName="DefaultAccessible">
<MemberSignature Language="C#" Value="public static Security.SecAccessible DefaultAccessible { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype Security.SecAccessible DefaultAccessible" />
<MemberSignature Language="DocId" Value="P:Xamarin.Essentials.SecureStorage.DefaultAccessible" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Security.SecAccessible</ReturnType>
</ReturnValue>
<Docs>
<summary>iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock.</summary>
<value>The SecAccessible to use for all KeyChain access.</value>
<remarks>For more information see: <see cref="https://developer.xamarin.com/api/type/Security.SecAccessible/" /></remarks>
</Docs>
</Member>
<Member MemberName="GetAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;string&gt; GetAsync (string key);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;string&gt; GetAsync(string key) cil managed" />
Expand All @@ -48,7 +66,35 @@
<param name="key">Storage Key.</param>
<summary>Gets the decrypted value for a given Key.</summary>
<returns>Decrypted string.</returns>
<remarks></remarks>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="GetAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task&lt;string&gt; GetAsync (string key, Security.SecAccessible accessible);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1&lt;string&gt; GetAsync(string key, valuetype Security.SecAccessible accessible) cil managed" />
<MemberSignature Language="DocId" Value="M:Xamarin.Essentials.SecureStorage.GetAsync(System.String,Security.SecAccessible)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;System.String&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="accessible" Type="Security.SecAccessible" />
</Parameters>
<Docs>
<param name="key">Storage Key.</param>
<param name="accessible">SecAccessible for iOS to use</param>
<summary>Gets the decrypted value for a given Key. iOS override to specify SecAccessible for the KeyChain.</summary>
<returns>
<para></para>
</returns>
<remarks>iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock.</remarks>
</Docs>
</Member>
<Member MemberName="SetAsync">
Expand All @@ -71,8 +117,42 @@
<param name="key">Storage Key.</param>
<param name="value">The value to be encrypted.</param>
<summary>Stores the value which is encrypted, for a given Key.</summary>
<returns></returns>
<remarks></remarks>
<returns>
<para></para>
</returns>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task SetAsync (string key, string value, Security.SecAccessible accessible);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task SetAsync(string key, string value, valuetype Security.SecAccessible accessible) cil managed" />
<MemberSignature Language="DocId" Value="M:Xamarin.Essentials.SecureStorage.SetAsync(System.String,System.String,Security.SecAccessible)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Xamarin.Essentials</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="value" Type="System.String" />
<Parameter Name="accessible" Type="Security.SecAccessible" />
</Parameters>
<Docs>
<param name="key">Storage Key.</param>
<param name="value">The value to be encrypted.</param>
<param name="accessible">To be added.</param>
<summary>Stores the value which is encrypted, for a given Key. iOS override to specify SecAccessible for the KeyChain.</summary>
<returns>
<para></para>
</returns>
<remarks>
<para></para>
</remarks>
</Docs>
</Member>
</Members>
Expand Down