Skip to content

Commit

Permalink
docs: update essentials scaffolding
Browse files Browse the repository at this point in the history
  • Loading branch information
dansiegel committed Oct 25, 2024
1 parent 5234537 commit 939ce3a
Show file tree
Hide file tree
Showing 31 changed files with 115 additions and 29 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
uid: Plugins.Essentials.AppContext
uid: Plugins.Essentials.ApplicationModel.AppContext
---

# AppContext
Expand Down
5 changes: 5 additions & 0 deletions docs/plugins/essentials/applicationmodel/browser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.ApplicationModel.Browser
---

# Browser
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.ApplicationModel.Communication.Email
---

# Email
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
uid: Plugins.Essentials.PhoneDialer
uid: Plugins.Essentials.ApplicationModel.Communication.PhoneDialer
---

# Phone Dialer
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Email
href: email.md
- name: Phone Dialer
href: phonedialer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.ApplicationModel.DataTransfer.Clipboard
---

# Clipboard
2 changes: 2 additions & 0 deletions docs/plugins/essentials/applicationmodel/datatransfer/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Clipboard
href: clipboard.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
uid: Plugins.Essentials.LatestVersion
uid: Plugins.Essentials.ApplicationModel.LatestVersion
---

# Latest Version
Expand Down
5 changes: 5 additions & 0 deletions docs/plugins/essentials/applicationmodel/launcher.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.ApplicationModel.Launcher
---

# Launcher
14 changes: 14 additions & 0 deletions docs/plugins/essentials/applicationmodel/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
- name: App Context
href: appcontext.md
- name: Browser
href: browser.md
- name: Communication
href: communication/toc.yml
- name: Data Transfer
href: datatransfer/toc.yml
- name: LatestVersion
href: latestversion.md
- name: Launcher
href: launcher.md
- name: Version Tracking
href: versiontracking.md
5 changes: 5 additions & 0 deletions docs/plugins/essentials/applicationmodel/versiontracking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.ApplicationModel.VersionTracking
---

# Version Tracking
5 changes: 0 additions & 5 deletions docs/plugins/essentials/battery.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/plugins/essentials/devices/battery.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.Devices.Battery
---

# Battery
5 changes: 5 additions & 0 deletions docs/plugins/essentials/devices/deviceinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.Devices.DeviceInfo
---

# DeviceInfo
5 changes: 5 additions & 0 deletions docs/plugins/essentials/devices/sensors/biometrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.Devices.Sensors.Biometrics
---

# Biometrics
5 changes: 5 additions & 0 deletions docs/plugins/essentials/devices/sensors/geocoding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.Devices.Sensors.Geocoding
---

# Geocoding
5 changes: 5 additions & 0 deletions docs/plugins/essentials/devices/sensors/geofencing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.Devices.Sensors.Geofencing
---

# Geofencing
5 changes: 5 additions & 0 deletions docs/plugins/essentials/devices/sensors/geolocation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
uid: Plugins.Essentials.Devices.Senors.Geolocation
---

# Geolocation
8 changes: 8 additions & 0 deletions docs/plugins/essentials/devices/sensors/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- name: Biometrics
href: biometrics.md
- name: Geocoding
href: geocoding.md
- name: Geofencing
href: geofencing.md
- name: Geolocation
href: geolocation.md
4 changes: 4 additions & 0 deletions docs/plugins/essentials/devices/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: Battery
href: battery.md
- name: Sensors
href: sensors/toc.yml
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/plugins/essentials/io/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: File System
href: filesystem.md
- name: Stores
href: stores.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
uid: Plugins.Essentials.Connectivity
uid: Plugins.Essentials.Networking.Connectivity
---

# Connectivity
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/essentials/networking/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Connectivity
href: connectivity.md
6 changes: 3 additions & 3 deletions docs/plugins/essentials/notifications/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ public class MyViewModel(INotifications notifications)

## Next Steps

- [ActionSheets](xref:Prism.Essentials.Notifications.ActionSheets)
- [Alerts](xref:Prism.Essentials.Notifications.Alerts)
- [Prompts](xref:Prism.Essentials.Notifications.Prompts)
- [ActionSheets](xref:Plugins.Essentials.Notifications.ActionSheets)
- [Alerts](xref:Plugins.Essentials.Notifications.Alerts)
- [Prompts](xref:Plugins.Essentials.Notifications.Prompts)

> [!NOTE]
> This is currently only supported on Android, iOS, MacCatalyst, & WinUI for .NET MAUI and Uno Platform. This feature is planned for future expansion to all Uno Platform platforms and WPF.
2 changes: 1 addition & 1 deletion docs/plugins/essentials/notifications/prompts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
uid: Plugins.Essentials.Notifications.ActionSheets
uid: Plugins.Essentials.Notifications.Prompts
---

# Prompts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
uid: Plugins.Essentials.MainThread
uid: Plugins.Essentials.Threading.MainThread
---

# Main Thread
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/essentials/threading/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Main Thread
href: mainthread.md
24 changes: 10 additions & 14 deletions docs/plugins/essentials/toc.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
- name: Getting Started
href: index.md
- name: App Context
href: appcontext.md
- name: Connectivity
href: connectivity.md
- name: File System
href: filesystem.md
- name: LatestVersion
href: latestversion.md
- name: Main Thread
href: mainthread.md
- name: ApplicationModel
href: applicationmodel/toc.yml
- name: Devices
href: devices/toc.yml
- name: IO
href: io/toc.yml
- name: Networking
href: networking/toc.yml
- name: Notifications
href: notifications/toc.yml
- name: Permissions
href: permissions.md
- name: Phone Dialer
href: phonedialer.md
- name: Stores
href: stores.md
- name: Threading
href: threading/toc.yml
2 changes: 1 addition & 1 deletion docs/plugins/logging/raygun.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ container.UsePrismLogging(logging =>

## Prism.Essentials Integration

The Raygun Implementation of the Logger makes reference to the [Prism.Plugin.Essentials](xref:Plugins.Essentials.GettingStarted) library. This allows us to dynamically check if various Essentials interfaces have been registered. If they have we automatically tailor the Logger to include offline support with request caching. Additionally we will automatically update the configuration to make use of the [Application Context](xref:Plugins.Essentials.AppContext) from Essentials. In order to enable sending logs in the background with the offline store, be sure to Register Prism.Plugin.Essentials first.
The Raygun Implementation of the Logger makes reference to the [Prism.Plugin.Essentials](xref:Plugins.Essentials.GettingStarted) library. This allows us to dynamically check if various Essentials interfaces have been registered. If they have we automatically tailor the Logger to include offline support with request caching. Additionally we will automatically update the configuration to make use of the [Application Context](xref:Plugins.Essentials.ApplicationModel.AppContext) from Essentials. In order to enable sending logs in the background with the offline store, be sure to Register Prism.Plugin.Essentials first.

0 comments on commit 939ce3a

Please sign in to comment.