From 6a0f2d98dee47bf9898e95f742f51cfdb74df850 Mon Sep 17 00:00:00 2001 From: Dan Siegel Date: Fri, 18 Oct 2024 16:42:22 -0600 Subject: [PATCH] chore: adding missing Essentials APIs --- docs/plugins/essentials/latestversion.md | 24 ++++++++++++++++++++++++ docs/plugins/essentials/phonedialer.md | 16 ++++++++++++++++ docs/plugins/essentials/toc.yml | 6 ++++++ 3 files changed, 46 insertions(+) create mode 100644 docs/plugins/essentials/latestversion.md create mode 100644 docs/plugins/essentials/phonedialer.md diff --git a/docs/plugins/essentials/latestversion.md b/docs/plugins/essentials/latestversion.md new file mode 100644 index 0000000..3f7b4f6 --- /dev/null +++ b/docs/plugins/essentials/latestversion.md @@ -0,0 +1,24 @@ +--- +uid: Plugins.Essentials.LatestVersion +--- + +# Latest Version + +The `ILatestVersion` provides a cross platform and cross framework API to check if your app is up to date. By default this is Support on Android, iOS, MacCatalyst and WinUI. The interface is also resolvable for WPF and the remaining Uno Platform targets. For the unsupported targets `SupportsAppStore` will return false. `IsUsingLatestVersion` will return true and `GetLatestVersionNumber` will return the current app version. `OpenAppInStore` will throw a `PlatformNotSupportedException`. + +```cs +public interface ILatestVersion +{ + string CountryCode { get; set; } + + string InstalledVersionNumber { get; } + + bool SupportsAppStore { get; } + + Task IsUsingLatestVersion(); + + Task GetLatestVersionNumber(); + + Task OpenAppInStore(); +} +``` diff --git a/docs/plugins/essentials/phonedialer.md b/docs/plugins/essentials/phonedialer.md new file mode 100644 index 0000000..5220d87 --- /dev/null +++ b/docs/plugins/essentials/phonedialer.md @@ -0,0 +1,16 @@ +--- +uid: Plugins.Essentials.PhoneDialer +--- + +# Phone Dialer + +The `IPhoneDialer` provides a cross platform API to open a Phone number on Android and iOS. This API is exposed on all Prism platforms and will provide a default implementation where `IsSupported` will provide a value of false. You should check this before attempting to open a phone number. + +```cs +public interface IPhoneDialer +{ + bool IsSupported { get; } + + void Open(string number); +} +``` \ No newline at end of file diff --git a/docs/plugins/essentials/toc.yml b/docs/plugins/essentials/toc.yml index e61e1db..1cd3074 100644 --- a/docs/plugins/essentials/toc.yml +++ b/docs/plugins/essentials/toc.yml @@ -6,7 +6,13 @@ href: connectivity.md - name: File System href: filesystem.md +- name: LatestVersion + href: latestversion.md - name: Main Thread href: mainthread.md +- name: Permissions + href: permissions.md +- name: Phone Dialer + href: phonedialer.md - name: Stores href: stores.md \ No newline at end of file