From e2ee8dc11e8a6a03292a15cd95329bb83963611c Mon Sep 17 00:00:00 2001 From: Matthew Leibowitz Date: Tue, 8 May 2018 18:47:01 +0200 Subject: [PATCH 1/3] Update the docs with the latest APIs --- .../xamarin-essentials-android.xml | 2 +- .../xamarin-essentials-ios.xml | 5 +- .../xamarin-essentials-uwp.xml | 2 +- .../en/FrameworksIndex/xamarin-essentials.xml | 2 +- docs/en/Xamarin.Essentials/Locale.xml | 34 +++++----- docs/en/Xamarin.Essentials/SecureStorage.xml | 68 +++++++++++++++++++ 6 files changed, 92 insertions(+), 21 deletions(-) diff --git a/docs/en/FrameworksIndex/xamarin-essentials-android.xml b/docs/en/FrameworksIndex/xamarin-essentials-android.xml index 4e74a9ce5..417b003a1 100644 --- a/docs/en/FrameworksIndex/xamarin-essentials-android.xml +++ b/docs/en/FrameworksIndex/xamarin-essentials-android.xml @@ -207,9 +207,9 @@ + - diff --git a/docs/en/FrameworksIndex/xamarin-essentials-ios.xml b/docs/en/FrameworksIndex/xamarin-essentials-ios.xml index 31d985b0f..8cd262658 100644 --- a/docs/en/FrameworksIndex/xamarin-essentials-ios.xml +++ b/docs/en/FrameworksIndex/xamarin-essentials-ios.xml @@ -207,9 +207,9 @@ + - @@ -337,7 +337,10 @@ + + + diff --git a/docs/en/FrameworksIndex/xamarin-essentials-uwp.xml b/docs/en/FrameworksIndex/xamarin-essentials-uwp.xml index 846c3db42..25047b73e 100644 --- a/docs/en/FrameworksIndex/xamarin-essentials-uwp.xml +++ b/docs/en/FrameworksIndex/xamarin-essentials-uwp.xml @@ -207,9 +207,9 @@ + - diff --git a/docs/en/FrameworksIndex/xamarin-essentials.xml b/docs/en/FrameworksIndex/xamarin-essentials.xml index 37fedf73b..d804a830a 100644 --- a/docs/en/FrameworksIndex/xamarin-essentials.xml +++ b/docs/en/FrameworksIndex/xamarin-essentials.xml @@ -207,9 +207,9 @@ + - diff --git a/docs/en/Xamarin.Essentials/Locale.xml b/docs/en/Xamarin.Essentials/Locale.xml index 9696eb75f..a3613e13f 100644 --- a/docs/en/Xamarin.Essentials/Locale.xml +++ b/docs/en/Xamarin.Essentials/Locale.xml @@ -33,10 +33,10 @@ This value may vary between platforms. - - - - + + + + Property Xamarin.Essentials @@ -46,15 +46,15 @@ System.String - Language name or code. + Unique Id of the Locale. - This value may vary between platforms. + - - - - + + + + Property Xamarin.Essentials @@ -64,15 +64,15 @@ System.String - Display name of the Locale. + Language name or code. - + This value may vary between platforms. - - - - + + + + Property Xamarin.Essentials @@ -82,7 +82,7 @@ System.String - Unique Id of the Locale. + Display name of the Locale. diff --git a/docs/en/Xamarin.Essentials/SecureStorage.xml b/docs/en/Xamarin.Essentials/SecureStorage.xml index ec0070afa..445f41f0d 100644 --- a/docs/en/Xamarin.Essentials/SecureStorage.xml +++ b/docs/en/Xamarin.Essentials/SecureStorage.xml @@ -29,6 +29,24 @@ + + + + + Property + + Xamarin.Essentials + 1.0.0.0 + + + Security.SecAccessible + + + To be added. + To be added. + To be added. + + @@ -51,6 +69,30 @@ + + + + + Method + + Xamarin.Essentials + 1.0.0.0 + + + System.Threading.Tasks.Task<System.String> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -75,5 +117,31 @@ + + + + + Method + + Xamarin.Essentials + 1.0.0.0 + + + System.Threading.Tasks.Task + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + From 7b6efde011abe3309adbf091f61868cad0680e86 Mon Sep 17 00:00:00 2001 From: James Montemagno Date: Fri, 11 May 2018 09:39:20 -0700 Subject: [PATCH 2/3] Add docs for SecAccessible --- docs/en/Xamarin.Essentials/SecureStorage.xml | 42 ++++++++++++-------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/docs/en/Xamarin.Essentials/SecureStorage.xml b/docs/en/Xamarin.Essentials/SecureStorage.xml index 445f41f0d..dda3bc099 100644 --- a/docs/en/Xamarin.Essentials/SecureStorage.xml +++ b/docs/en/Xamarin.Essentials/SecureStorage.xml @@ -16,7 +16,7 @@ Each platform uses the platform provided native API's for storing data securely: - iOS: Data is stored in KeyChain. + iOS: Data is stored in KeyChain. Additional information on SecAccessible at: Android: Encryption keys are stored in KeyStore and encrypted data is stored in a named shared preference container (PackageId.Xamarin.Essentials). @@ -42,9 +42,9 @@ Security.SecAccessible - To be added. - To be added. - To be added. + iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock. + The SecAccessible to use for all KeyChain access. + For more information see: @@ -66,7 +66,9 @@ Storage Key. Gets the decrypted value for a given Key. Decrypted string. - + + + @@ -86,11 +88,13 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + Storage Key. + SecAccessible for iOS to use + Gets the decrypted value for a given Key. iOS override to specify SecAccessible for the KeyChain. + iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock. + + + @@ -113,8 +117,12 @@ Storage Key. The value to be encrypted. Stores the value which is encrypted, for a given Key. - - + + + + + + @@ -135,12 +143,14 @@ - To be added. + Storage Key. To be added. To be added. - To be added. - To be added. - To be added. + Stores the value which is encrypted, for a given Key. iOS override to specify SecAccessible for the KeyChain. + Stores the value which is encrypted, for a given Key. iOS override to specify SecAccessible for the KeyChain. + + + From 226c36169dda02247a544deb0af9f26daadfe14d Mon Sep 17 00:00:00 2001 From: Matthew Leibowitz Date: Sat, 12 May 2018 13:17:37 +0200 Subject: [PATCH 3/3] Update SecureStorage.xml --- docs/en/Xamarin.Essentials/SecureStorage.xml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/en/Xamarin.Essentials/SecureStorage.xml b/docs/en/Xamarin.Essentials/SecureStorage.xml index dda3bc099..554fa274a 100644 --- a/docs/en/Xamarin.Essentials/SecureStorage.xml +++ b/docs/en/Xamarin.Essentials/SecureStorage.xml @@ -91,10 +91,10 @@ Storage Key. SecAccessible for iOS to use Gets the decrypted value for a given Key. iOS override to specify SecAccessible for the KeyChain. - iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock. - - - + + + + iOS: Default SecAccessible to use for all Get/Set calls to KeyChain. Default value is AfterFirstUnlock. @@ -144,10 +144,12 @@ Storage Key. - To be added. + The value to be encrypted. To be added. Stores the value which is encrypted, for a given Key. iOS override to specify SecAccessible for the KeyChain. - Stores the value which is encrypted, for a given Key. iOS override to specify SecAccessible for the KeyChain. + + +