Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eBardX/XestiMonitors

An extensible monitoring framework written in Swift
https://github.com/eBardX/XestiMonitors

cocoapod extensible framework ios macos monitoring swift tvos watchos

Last synced: 3 days ago
JSON representation

An extensible monitoring framework written in Swift

Awesome Lists containing this project

README

        

# XestiMonitors

[![Swift 4.x](https://img.shields.io/badge/Swift-4.x-orange.svg)](https://developer.apple.com/swift/)
[![License](https://img.shields.io/cocoapods/l/XestiMonitors.svg)](http://cocoapods.org/pods/XestiMonitors)
[![Platform](https://img.shields.io/cocoapods/p/XestiMonitors.svg)](http://cocoapods.org/pods/XestiMonitors)

[![Build Status](https://img.shields.io/travis/eBardX/XestiMonitors/master.svg?colorB=4BC51D)](https://travis-ci.org/eBardX/XestiMonitors)
[![Code Coverage](https://img.shields.io/codecov/c/github/eBardX/XestiMonitors/master.svg?colorB=4BC51D)](https://codecov.io/github/eBardX/XestiMonitors)
[![Documented](https://img.shields.io/cocoapods/metrics/doc-percent/XestiMonitors.svg?colorB=4BC51D)](http://ebardx.github.io/XestiMonitors/)

[![CocoaPods](https://img.shields.io/cocoapods/v/XestiMonitors.svg?colorB=4BC51D)](http://cocoapods.org/pods/XestiMonitors)
[![Carthage](https://img.shields.io/badge/carthage-compatible-brightgreen.svg)](https://github.com/Carthage/Carthage)
[![Swift Package Manager](https://img.shields.io/badge/spm-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

* [Overview](#overview)
* [Reference Documentation](#reference_documentation)
* [Requirements](#requirements)
* [Installation](#installation)
* [CocoaPods](#cocoapods_installation)
* [Carthage](#carthage_installation)
* [Swift Package Manager](#spm_installation)
* [Usage](#usage)
* [Core Location Monitors](#core_location_monitors)
* [Core Motion Monitors](#core_motion_monitors)
* [Foundation Monitors](#foundation_monitors)
* [UIKit Monitors](#uikit_monitors)
* [Accessibility Monitors](#accessibility_monitors)
* [Application Monitors](#application_monitors)
* [Device Monitors](#device_monitors)
* [Screen Monitors](#screen_monitors)
* [Text Monitors](#text_monitors)
* [Other UIKit Monitors](#other_uikit_monitors)
* [Other Monitors](#other_monitors)
* [Custom Monitors](#custom_monitors)
* [Credits](#credits)
* [License](#license)

## Overview

The XestiMonitors framework provides more than *sixty* fully-functional monitor
classes right out of the box that make it easy for your app to detect and
respond to many common system-generated events.

Among other things, you can think of XestiMonitors as a better way to manage
the most common notifications (primarily on iOS and tvOS). At present,
XestiMonitors provides “wrappers” around nearly all `UIKit` notifications (see
[UIKit Monitors](#uikit_monitors)) and many `Foundation` notifications (see
[Foundation Monitors](#foundation_monitors)).

XestiMonitors also provides convenient “wrappers” around several frameworks and
programming interfaces to make them easier for your app to use:

* It wraps the Core Location framework to make it easier for your app to make
easier for your app to determine the device’s geographic location, altitude,
or orientation; or its position relative to a nearby iBeacon. See
[Core Location Monitors](#core_location_monitors) for details.
* It wraps the Core Motion framework to make it easier for your app to obtain
both raw and processed motion measurements from the device. See
[Core Motion Monitors](#core_motion_monitors) for details.
* It wraps the `SCNetworkReachability` programming interface to make it super
easy for your app to determine the reachability of a target host. See
[Other Monitors](#other_monitors) for details.

Additional monitors targeting more parts of all four platforms will be rolled
out in future releases of XestiMonitors!

Finally, XestiMonitors is *extensible*—you can easily create your own *custom*
monitors. See [Custom Monitors](#custom_monitors) for details.

## Reference Documentation

Full [reference documentation][refdoc] is available courtesy of [Jazzy][jazzy].

## Requirements

* iOS 9.0+ / macOS 10.10+ / tvOS 9.0+ / watchOS 2.0+
* Xcode 9.0+
* Swift 4.0+

## Installation

### CocoaPods

[CocoaPods][cocoapods] is a dependency manager for Cocoa projects. You can
install it with the following command:

```
$ gem install cocoapods
```

To integrate XestiMonitors into your Xcode project using CocoaPods, specify it
in your `Podfile`:

```
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!

target '' do
pod 'XestiMonitors'
end
```

Then, run the following command:

```
$ pod install
```

### Carthage

[Carthage][carthage] is a decentralized dependency manager that builds your
dependencies and provides you with binary frameworks.

You can install Carthage with [Homebrew][homebrew] using the following commands:

```
$ brew update
$ brew install carthage
```

To integrate XestiMonitors into your Xcode project using Carthage, specify it
in your `Cartfile`:

```
github "eBardX/XestiMonitors"
```

Then, run the following command:

```
$ carthage update
```

Finally, drag the built `XestiMonitors.framework` into your Xcode project.

### Swift Package Manager

The [Swift Package Manager][spm] is a tool for automating the distribution of
Swift code and is integrated into the swift compiler. It is in early
development, but XestiMonitors does support its use on supported platforms.

Once you have your Swift package set up, adding XestiMonitors as a dependency
is as easy as adding it to the `dependencies` value of your `Package.swift`.

```
dependencies: [
.Package(url: "https://github.com/eBardX/XestiMonitors.git")
]
```

## Usage

All monitor classes conform to the [Monitor][p_monitor] protocol, thus
enabling you to create arrays of monitors that can be started or
stopped uniformly—fewer lines of code!

For example, in a view controller, you can lazily instantiate several
monitors and, in addition, lazily instantiate an array variable containing
these monitors:

```
import XestiMonitors

lazy var keyboardMonitor = KeyboardMonitor { [unowned self] in
// do something…
}
lazy var memoryMonitor = MemoryMonitor { [unowned self] in
// do something…
}
lazy var orientationMonitor = OrientationMonitor { [unowned self] in
// do something…
}
lazy var monitors: [Monitor] = [keyboardMonitor,
memoryMonitor,
orientationMonitor]
```

Then, in the `viewWillAppear(_:)` and `viewWillDisappear(_:)` methods, you can
simply start or stop all these monitors with a single line of code:

```
override func viewWillAppear(_ animated: Bool) {
super.viewWillAppear(animated)
monitors.forEach { $0.startMonitoring() }
}

override func viewWillDisappear(_ animated: Bool) {
monitors.forEach { $0.stopMonitoring() }
super.viewWillDisappear(animated)
}
```

Easy peasy!

### Core Location Monitors

XestiMonitors provides seven monitor classes wrapping the Core Location
framework that you can use to determine the device’s geographic location,
altitude, or orientation; or its position relative to a nearby iBeacon:

* [BeaconRangingMonitor][beacon_ranging_monitor] to monitor a region for
changes to the ranges (*i.e.,* the relative proximity) to the Bluetooth
low-energy beacons within. *(iOS)*
* [HeadingMonitor][heading_monitor] to monitor the device for changes to its
current heading. *(iOS)*
* [LocationAuthorizationMonitor][location_authorization_monitor] to monitor the
app for updates to its authorization to use location services. *(iOS, macOS,
tvOS, watchOS)*
* [RegionMonitor][region_monitor] to monitor a region for changes to its state
(which indicate boundary transitions). *(iOS, macOS)*
* [SignificantLocationMonitor][significant_location_monitor] to monitor the
device for *significant* changes to its current location. *(iOS, macOS)*
* [StandardLocationMonitor][standard_location_monitor] to monitor the device
for changes to its current location. *(iOS, macOS, tvOS, watchOS)*
* [VisitMonitor][visit_monitor] to monitor for locations that the user stops at
for a “noteworthy” amount of time. *(iOS)*

### Core Motion Monitors

XestiMonitors provides seven monitor classes wrapping the Core Motion framework
that you can use to obtain raw and processed motion measurements from the
device:

* [AccelerometerMonitor][accelerometer_monitor] to monitor the device’s
accelerometer for periodic raw measurements of the acceleration along the
three spatial axes. *(iOS, watchOS)*
* [AltimeterMonitor][altimeter_monitor] to monitor the device for changes in
relative altitude. *(iOS, watchOS)*
* [DeviceMotionMonitor][device_motion_monitor] to monitor the device’s
accelerometer, gyroscope, and magnetometer for periodic raw measurements
which are processed into device motion measurements. *(iOS, watchOS)*
* [GyroscopeMonitor][gyroscope_monitor] to monitor the device’s gyroscope for
periodic raw measurements of the rotation rate around the three spatial axes.
*(iOS, watchOS)*
* [MagnetometerMonitor][magnetometer_monitor] to monitor the device’s
magnetometer for periodic raw measurements of the magnetic field around the
three spatial axes. *(iOS, watchOS)*
* [MotionActivityMonitor][motion_activity_monitor] to monitor the device for
live and historic motion data. *(iOS, watchOS)*
* [PedometerMonitor][pedometer_monitor] to monitor the device for live and
historic walking data. *(iOS, watchOS)*

### Foundation Monitors

XestiMonitors provides seventeen monitors wrapping
[`Foundation` notifications][wrapped_foundation_notifications]:

* [BundleClassLoadMonitor][bundle_class_load_monitor] to monitor a bundle for
dynamic loads of classes. *(iOS, macOS, tvOS, watchOS)*
* [BundleResourceRequestMonitor][bundle_resource_request_monitor] to monitor
the system to detect if the amount of available disk space for on-demand
resources is getting low. *(iOS, tvOS, watchOS)*
* [CalendarDayMonitor][calendar_day_monitor] to monitor the system for changes
to the calendar day. *(iOS, macOS, tvOS, watchOS)*
* [CurrentLocaleMonitor][current_locale_monitor] to monitor the system for
changes to the user’s locale. *(iOS, macOS, tvOS, watchOS)*
* [ExtensionHostMonitor][extension_host_monitor] to monitor an extension
context for changes to the runtime state of the extension’s host app.
*(iOS, tvOS, watchOS)*
* [HTTPCookiesStorageMonitor][http_cookies_storage_monitor] instance to monitor
an HTTP cookie storage object for changes to its acceptance policy or to its
cookies. *(iOS, macOS, tvOS, watchOS)*
* [MetadataQueryMonitor][metadata_query_monitor] to monitor a metadata query
for changes to its results. *(iOS, macOS, tvOS, watchOS)*
* [PortMonitor][port_monitor] to monitor a port for changes to its validity.
*(iOS, macOS, tvOS, watchOS)*
* [ProcessInfoPowerStateMonitor][process_info_power_state_monitor] to monitor
the device for changes to its power state (Low Power Mode is enabled or
disabled). *(iOS, tvOS, watchOS)*
* [ProcessInfoThermalStateMonitor][process_info_thermal_state_monitor] to
monitor the system for changes to the thermal state.
*(iOS, macOS, tvOS, watchOS)*
* [SystemClockMonitor][system_clock_monitor] to monitor the system for changes
to the clock. *(iOS, macOS, tvOS, watchOS)*
* [SystemTimeZoneMonitor][system_time_zone_monitor] to monitor the system for
changes to the currently used time zone. *(iOS, macOS, tvOS, watchOS)*
* [UbiquitousKeyValueStoreMonitor][ubiquitous_key_value_store_monitor] to
monitor the iCloud (“ubiquitous”) key-value store for changes due to incoming
data pushed from iCloud. *(iOS, macOS, tvOS)*
* [UbiquityIdentityMonitor][ubiquity_identity_monitor] to monitor the system
for changes to the iCloud (”ubiquity”) identity. *(iOS, macOS, tvOS, watchOS)*
* [UndoManagerMonitor][undo_manager_monitor] to monitor an undo manager for
changes to its recording of operations. *(iOS, macOS, tvOS, watchOS)*
* [URLCredentialStorageMonitor][url_credential_storage_monitor] to monitor the
shared URL credential storage object for changes to its stored credentials.
*(iOS, macOS, tvOS, watchOS)*
* [UserDefaultsMonitor][user_defaults_monitor] to monitor a user defaults
object for changes to its data. *(iOS, macOS, tvOS, watchOS)*

### UIKit Monitors

XestiMonitors provides numerous monitors wrapping
[`UIKit` notifications][wrapped_uikit_notifications].

#### Accessibility Monitors

XestiMonitors provides three monitor classes that you can use to observe
accessibility events generated by the system:

* [AccessibilityAnnouncementMonitor][accessibility_announcement_monitor] to
monitor the system for accessibility announcements that VoiceOver has
finished outputting. *(iOS, tvOS)*
* [AccessibilityElementMonitor][accessibility_element_monitor] to monitor the
system for changes to element focus by an assistive technology. *(iOS, tvOS)*
* [AccessibilityStatusMonitor][accessibility_status_monitor] to monitor the
system for changes to the status of various accessibility settings.
*(iOS, tvOS)*

#### Application Monitors

XestiMonitors provides seven monitor classes that you can use to observe common
events generated by the system about the app:

* [ApplicationStateMonitor][application_state_monitor] to monitor the app for
changes to its runtime state. *(iOS, tvOS)*
* [BackgroundRefreshMonitor][background_refresh_monitor] to monitor the app for
changes to its status for downloading content in the background. *(iOS)*
* [MemoryMonitor][memory_monitor] to monitor the app for memory warnings from
the operating system. *(iOS, tvOS)*
* [ProtectedDataMonitor][protected_data_monitor] to monitor the app for changes
to the accessibility of protected files. *(iOS, tvOS)*
* [ScreenshotMonitor][screenshot_monitor] to monitor the app for screenshots.
*(iOS, tvOS)*
* [StatusBarMonitor][status_bar_monitor] to monitor the app for changes to the
orientation of its user interface or to the frame of the status bar. *(iOS)*
* [TimeMonitor][time_monitor] to monitor the app for significant changes in
time. *(iOS, tvOS)*

#### Device Monitors

XestiMonitors provides three monitor classes that you can use to detect changes
in the characteristics of the device:

* [BatteryMonitor][battery_monitor] to monitor the device for changes to the
charge state and charge level of its battery. *(iOS)*
* [OrientationMonitor][orientation_monitor] to monitor the device for changes
to its physical orientation. *(iOS)*
* [ProximityMonitor][proximity_monitor] to monitor the device for changes to
the state of its proximity sensor. *(iOS)*

#### Screen Monitors

XestiMonitors provides four monitor classes that you can use to detect changes
in the properties associated with a screen:

* [ScreenBrightnessMonitor][screen_brightness_monitor] to monitor a screen for
changes to its brightness level. *(iOS, tvOS)*
* [ScreenCapturedMonitor][screen_captured_monitor] to monitor a screen for
changes to its captured status. *(iOS, tvOS)*
* [ScreenConnectionMonitor][screen_connection_Monitor] to monitor the device
for screen connections and disconnections. *(iOS, tvOS)*
* [ScreenModeMonitor][screen_mode_monitor] to monitor a screen for changes to
its current mode. *(iOS, tvOS)*

#### Text Monitors

XestiMonitors provides four monitor classes that you can use to detect changes
in text input mode and content:

* [TextFieldTextMonitor][text_field_text_monitor] to monitor a text field for
changes to its text. *(iOS, tvOS)*
* [TextInputModeMonitor][text_input_mode_monitor] to monitor the responder
chain for changes to the current input mode. *(iOS, tvOS)*
* [TextStorageMonitor][text_storage_monitor] to monitor a text storage for the
processing of edits to its contents. *(iOS, tvOS)*
* [TextViewTextMonitor][text_view_text_monitor] to monitor a text view for
changes to its text. *(iOS, tvOS)*

#### Other UIKit Monitors

In addition, XestiMonitors provides nine other `UIKit` monitors:

* [ContentSizeCategoryMonitor][content_size_category_monitor] to monitor the
app for changes to its preferred content size category. *(iOS, tvOS)*
* [DocumentStateMonitor][document_state_monitor] to monitor a document for
changes to its state. *(iOS)*
* [FocusMonitor][focus_monitor] to monitor the app for changes to the current
focus in the view hierarchy. *(iOS, tvOS)*
* [KeyboardMonitor][keyboard_monitor] to monitor the keyboard for changes to
its visibility or to its frame. *(iOS)*
* [MenuControllerMonitor][menu_controller_monitor] to monitor the menu
controller for changes to the visibility of the editing menu or to the frame
of the editing menu. *(iOS)*
* [PasteboardMonitor][pasteboard_monitor] to monitor a pasteboard for changes
to its contents or for its removal from the app. *(iOS)*
* [TableViewSelectionMonitor][table_view_selection_monitor] to monitor a table
view for changes to its selected row. *(iOS, tvOS)*
* [ViewControllerShowDetailTargetMonitor][view_controller_show_detail_target_monitor]
to monitor the app for changes to a split view controller’s display mode in
the view hierarchy. *(iOS, tvOS)*
* [WindowMonitor][window_monitor] to monitor a window for changes to its
visibility or key status. *(iOS, tvOS)*

[KeyboardMonitor][keyboard_monitor] is especially handy in removing lots of
boilerplate code from your app. This is how keyboard monitoring is typically
handled in a custom view controller:

```
func keyboardWillHide(_ notification: Notification) {
let userInfo = notification.userInfo
var animationDuration: TimeInterval = 0
if let value = (userInfo?[UIKeyboardAnimationDurationUserInfoKey] as? NSNumber)?.doubleValue {
animationDuration = value
}
constraint.constant = 0
UIView.animate(withDuration: animationDuration) {
self.view.layoutIfNeeded()
}
}

func keyboardWillShow(_ notification: Notification) {
let userInfo = notification.userInfo
var animationDuration: TimeInterval = 0
if let value = (userInfo?[UIKeyboardAnimationDurationUserInfoKey] as? NSNumber)?.doubleValue {
animationDuration = value
}
var frameEnd = CGRect.zero
if let value = (userInfo?[UIKeyboardFrameEndUserInfoKey] as? NSValue)?.cgRectValue {
frameEnd = value
}
constraint.constant = frameEnd.height
UIView.animate(withDuration: animationDuration) {
self.view.layoutIfNeeded()
}
}

override func viewWillAppear(_ animated: Bool) {
super.viewWillAppear(animated)
let nc = NotificationCenter.`default`
nc.addObserver(self, selector: #selector(keyboardWillHide(_:)),
name: .UIKeyboardWillHide, object: nil)
nc.addObserver(self, selector: #selector(keyboardWillShow(_:)),
name: .UIKeyboardWillShow, object: nil)
}

override func viewWillDisappear(_ animated: Bool) {
NotificationCenter.`default`.removeObserver(self)
super.viewWillDisappear(animated)
}
```

And this is the XestiMonitors way using [KeyboardMonitor][keyboard_monitor]:

```
import XestiMonitors

lazy var keyboardMonitor = KeyboardMonitor { [unowned self] event in
guard let constraint = self?.constraint,
let view = self?.view else { return }
switch event {
case let .willHide(info):
constraint.constant = 0
UIView.animate(withDuration: info.animationDuration) {
view.layoutIfNeeded()
}
case let .willShow(info):
constraint.constant = info.frameEnd.height
UIView.animate(withDuration: info.animationDuration) {
view.layoutIfNeeded()
}
default:
break
}
}

override func viewWillAppear(_ animated: Bool) {
super.viewWillAppear(animated)
keyboardMonitor.startMonitoring()
}

override func viewWillDisappear(_ animated: Bool) {
keyboardMonitor.stopMonitoring()
super.viewWillDisappear(animated)
}
```

What’s in *your* wallet?

### Other Monitors

In addition, XestiMonitors provides two other monitors:

* [FileSystemObjectMonitor][file_system_object_monitor] to monitor a
file-system object for changes. *(iOS, macOS, tvOS, watchOS)*
* [NetworkReachabilityMonitor][network_reachability_monitor] to monitor a
network node name or address for changes to its reachability.
*(iOS, macOS, tvOS)*

### Custom Monitors

Best of all, the XestiMonitors framework provides several ways to create your
own custom monitors quite easily.

#### Implementing the Monitor Protocol

You can create a new class, or extend an existing class, that conforms to the
[Monitor][p_monitor] protocol. You need only implement the
[startMonitoring()][m_start_monitoring] and
[stopMonitoring()][m_stop_monitoring] methods, as well as the
[isMonitoring][m_is_monitoring] property:

```
import XestiMonitors

extension MegaHoobieWatcher: Monitor {
var isMonitoring: Bool { return watchingForHoobiesCount() > 0 }

func startMonitoring() -> Bool {
guard !isMonitoring else { return }
beginWatchingForHoobies()
}

func stopMonitoring() -> Bool {
guard isMonitoring else { return }
endWatchingForHoobies()
}
}
```

**Note:** The guard statements in both [startMonitoring()][m_start_monitoring]
and [stopMonitoring()][m_stop_monitoring] protect against starting or stopping
the monitor if it is in the incorrect state. This is considered good coding
practice.

#### Subclassing the BaseMonitor Class

Typically, you will want to create a subclass of [BaseMonitor][base_monitor].
The advantage of using this abstract base class is that the basic guard logic
is taken care of for you. Specifically, the
[startMonitoring()][bm_start_monitoring] method does not attempt to start the
monitor if it is already active, and the [stopMonitoring()][bm_stop_monitoring]
method does not attempt to stop the monitor if it is *not* active. Instead of
directly implementing the required protocol methods and properties, you need
only override the [configureMonitor()][bm_configureMonitor] and
[cleanupMonitor()][bm_cleanupMonitor] methods of this base class. In fact, you
will *not* be able to override the [startMonitoring()][bm_start_monitoring] and
[stopMonitoring()][bm_stop_monitoring] methods or the
[isMonitoring][bm_is_monitoring] property—they are declared `final` in
[BaseMonitor][base_monitor].

```
import XestiMonitors

class GigaHoobieMonitor: BaseMonitor {
let handler: (Float) -> Void
@objc let hoobie: GigaHoobie
private var observation: NSKeyValueObservation?

init(_ hoobie: GigaHoobie, handler: @escaping (Float) -> Void) {
self.handler = handler
self.hoobie = hoobie
}

override func configureMonitor() -> Bool {
super.configureMonitor()
observation = hoobie.observe(\.nefariousActivityLevel) { [unowned self] hoobie, _ in
self.handler(hoobie.nefariousActivityLevel) }
}

override func cleanupMonitor() -> Bool {
observation?.invalidate()
observation = nil
super.cleanupMonitor()
}
}
```

**Note:** Be sure to invoke the superclass implementations of both
[configureMonitor()][bm_configureMonitor] and
[cleanupMonitor()][bm_cleanupMonitor].

#### Subclassing the BaseNotificationMonitor Class

If your custom monitor determines events by observing notifications, you should
consider creating a subclass of
[BaseNotificationMonitor][base_notification_monitor] instead. In most cases you
need only override the
[addNotificationObservers(_:)][bnm_addNotificationObservers] method. You can
also override the
[removeNotificationObservers(_:)][bnm_removeNotificationObservers] method if
you require extra cleanup when the notification observers are removed upon
stopping the monitor. Although this base class inherits from
[BaseMonitor][base_monitor], you will *not* be able to override the
[configureMonitor()][bnm_configureMonitor] and
[cleanupMonitor()][bnm_cleanupMonitor] methods—they are declared `final` in
[BaseNotificationMonitor][base_notification_monitor].

```
import XestiMonitors

class TeraHoobieMonitor: BaseNotificationMonitor {
let handler: (Bool) -> Void
let hoobie: TeraHoobie

init(hoobie: TeraHoobie, queue: OperationQueue = .main,
handler: @escaping (Bool) -> Void) {
self.handler = handler
self.hoobie = hoobie
super.init(queue: queue)
}

override func addNotificationObservers() -> Bool {
super.addNotificationObservers()
observe(.teraHoobieDidChange) { [unowned self] _ in
self.handler(self.hoobie.value) }
}
}
```

**Note:** Be sure to invoke the superclass implementations of both
[addNotificationObservers(_:)][bnm_addNotificationObservers] and
[removeNotificationObservers(_:)][bnm_removeNotificationObservers] in your
overrides.

## Credits

J. G. Pusey ([email protected])

## License

XestiMonitors is available under [the MIT license][license].

[carthage]: https://github.com/Carthage/Carthage
[cocoapods]: http://cocoapods.org
[homebrew]: http://brew.sh/
[jazzy]: https://github.com/realm/jazzy
[license]: https://github.com/eBardX/XestiMonitors/blob/master/LICENSE.md
[refdoc]: https://eBardX.github.io/XestiMonitors/
[spm]: https://swift.org/package-manager/

[wrapped_foundation_notifications]: https://github.com/eBardX/XestiMonitors/blob/master/Documents/wrapped-foundation-notifications.md
[wrapped_uikit_notifications]: https://github.com/eBardX/XestiMonitors/blob/master/Documents/wrapped-uikit-notifications.md

[accelerometer_monitor]: https://eBardX.github.io/XestiMonitors/Classes/AccelerometerMonitor.html
[accessibility_announcement_monitor]: https://eBardX.github.io/XestiMonitors/Classes/AccessibilityAnnouncementMonitor.html
[accessibility_element_monitor]: https://eBardX.github.io/XestiMonitors/Classes/AccessibilityElementMonitor.html
[accessibility_status_monitor]: https://eBardX.github.io/XestiMonitors/Classes/AccessibilityStatusMonitor.html
[altimeter_monitor]: https://eBardX.github.io/XestiMonitors/Classes/AltimeterMonitor.html
[application_state_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ApplicationStateMonitor.html
[background_refresh_monitor]: https://eBardX.github.io/XestiMonitors/Classes/BackgroundRefreshMonitor.html
[base_monitor]: https://eBardX.github.io/XestiMonitors/Classes/BaseMonitor.html
[base_notification_monitor]: https://eBardX.github.io/XestiMonitors/Classes/BaseNotificationMonitor.html
[battery_monitor]: https://eBardX.github.io/XestiMonitors/Classes/BatteryMonitor.html
[beacon_ranging_monitor]: https://eBardX.github.io/XestiMonitors/Classes/BeaconRangingMonitor.html
[bundle_class_load_monitor]: https://eBardX.github.io/XestiMonitors/Classes/BundleClassLoadMonitor.html
[bundle_resource_request_monitor]: https://eBardX.github.io/XestiMonitors/Classes/BundleResourceRequestMonitor.html
[calendar_day_monitor]: https://eBardX.github.io/XestiMonitors/Classes/CalendarDayMonitor.html
[content_size_category_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ContentSizeCategoryMonitor.html
[current_locale_monitor]: https://eBardX.github.io/XestiMonitors/Classes/CurrentLocaleMonitor.html
[device_motion_monitor]: https://eBardX.github.io/XestiMonitors/Classes/DeviceMotionMonitor.html
[document_state_monitor]: https://eBardX.github.io/XestiMonitors/Classes/DocumentStateMonitor.html
[extension_host_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ExtensionHostMonitor.html
[file_system_object_monitor]: https://eBardX.github.io/XestiMonitors/Classes/FileSystemObjectMonitor.html
[focus_monitor]: https://eBardX.github.io/XestiMonitors/Classes/FocusMonitor.html
[gyroscope_monitor]: https://eBardX.github.io/XestiMonitors/Classes/GyroscopeMonitor.html
[heading_monitor]: https://eBardX.github.io/XestiMonitors/Classes/HeadingMonitor.html
[http_cookie_storage_monitor]: https://eBardX.github.io/XestiMonitors/Classes/HTTPCookieStorageMonitor.html
[keyboard_monitor]: https://eBardX.github.io/XestiMonitors/Classes/KeyboardMonitor.html
[location_authorization_monitor]: https://eBardX.github.io/XestiMonitors/Classes/LocationAuthorizationMonitor.html
[magnetometer_monitor]: https://eBardX.github.io/XestiMonitors/Classes/MagnetometerMonitor.html
[memory_monitor]: https://eBardX.github.io/XestiMonitors/Classes/MemoryMonitor.html
[menu_controller_monitor]: https://eBardX.github.io/XestiMonitors/Classes/MenuControllerMonitor.html
[metadata_query_monitor]: https://eBardX.github.io/XestiMonitors/Classes/MetadataQueryMonitor.html
[motion_activity_monitor]: https://eBardX.github.io/XestiMonitors/Classes/MotionActivityMonitor.html
[network_reachability_monitor]: https://eBardX.github.io/XestiMonitors/Classes/NetworkReachabilityMonitor.html
[orientation_monitor]: https://eBardX.github.io/XestiMonitors/Classes/OrientationMonitor.html
[pasteboard_monitor]: https://eBardX.github.io/XestiMonitors/Classes/PasteboardMonitor.html
[pedometer_monitor]: https://eBardX.github.io/XestiMonitors/Classes/PedometerMonitor.html
[port_monitor]: https://eBardX.github.io/XestiMonitors/Classes/PortMonitor.html
[process_info_power_state_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ProcessInfoPowerStateMonitor.html
[process_info_thermal_state_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ProcessInfoThermalStateMonitor.html
[protected_data_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ProtectedDataMonitor.html
[proximity_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ProximityMonitor.html
[region_monitor]: https://eBardX.github.io/XestiMonitors/Classes/RegionMonitor.html
[screen_brightness_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ScreenBrightnessMonitor.html
[screen_captured_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ScreenCapturedMonitor.html
[screen_connection_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ScreenConnectionMonitor.html
[screen_mode_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ScreenModeMonitor.html
[screenshot_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ScreenshotMonitor.html
[significant_location_monitor]: https://eBardX.github.io/XestiMonitors/Classes/SignificantLocationMonitor.html
[standard_location_monitor]: https://eBardX.github.io/XestiMonitors/Classes/StandardLocationMonitor.html
[status_bar_monitor]: https://eBardX.github.io/XestiMonitors/Classes/StatusBarMonitor.html
[system_clock_monitor]: https://eBardX.github.io/XestiMonitors/Classes/SystemClockMonitor.html
[system_time_zone_monitor]: https://eBardX.github.io/XestiMonitors/Classes/SystemTimeZoneMonitor.html
[table_view_selection_monitor]: https://eBardX.github.io/XestiMonitors/Classes/TableViewSelectionMonitor.html
[text_field_text_monitor]: https://eBardX.github.io/XestiMonitors/Classes/TextFieldTextMonitor.html
[text_input_mode_monitor]: https://eBardX.github.io/XestiMonitors/Classes/TextInputModeMonitor.html
[text_storage_monitor]: https://eBardX.github.io/XestiMonitors/Classes/TextStorageMonitor.html
[text_view_text_monitor]: https://eBardX.github.io/XestiMonitors/Classes/TextViewTextMonitor.html
[time_monitor]: https://eBardX.github.io/XestiMonitors/Classes/TimeMonitor.html
[ubiquitous_key_value_store_monitor]: https://eBardX.github.io/XestiMonitors/Classes/UbiquitousKeyValueStoreMonitor.html
[ubiquity_identity_monitor]: https://eBardX.github.io/XestiMonitors/Classes/UbiquityIdentityMonitor.html
[undo_manager_monitor]: https://eBardX.github.io/XestiMonitors/Classes/UndoManagerMonitor.html
[url_credential_storage_monitor]: https://eBardX.github.io/XestiMonitors/Classes/URLCredentialStorageMonitor.html
[user_defaults_monitor]: https://eBardX.github.io/XestiMonitors/Classes/UserDefaultsMonitor.html
[view_controller_show_detail_target_monitor]: https://eBardX.github.io/XestiMonitors/Classes/ViewControllerShowDetailTargetMonitor.html
[visit_monitor]: https://eBardX.github.io/XestiMonitors/Classes/VisitMonitor.html
[window_monitor]: https://eBardX.github.io/XestiMonitors/Classes/WindowMonitor.html

[p_monitor]: https://eBardX.github.io/XestiMonitors/Protocols/Monitor.html

[m_is_monitoring]: https://ebardx.github.io/XestiMonitors/Protocols/Monitor.html#/s:vP13XestiMonitors7Monitor12isMonitoringSb
[m_start_monitoring]: https://ebardx.github.io/XestiMonitors/Protocols/Monitor.html#/s:FP13XestiMonitors7Monitor15startMonitoringFT_Sb
[m_stop_monitoring]: https://ebardx.github.io/XestiMonitors/Protocols/Monitor.html#/s:FP13XestiMonitors7Monitor14stopMonitoringFT_Sb

[bm_cleanupMonitor]: https://eBardX.github.io/XestiMonitors/Classes/BaseMonitor.html#/s:FC13XestiMonitors11BaseMonitor14cleanupMonitorFT_Sb
[bm_configureMonitor]: https://eBardX.github.io/XestiMonitors/Classes/BaseMonitor.html#/s:FC13XestiMonitors11BaseMonitor16configureMonitorFT_Sb
[bm_is_monitoring]: https://eBardX.github.io/XestiMonitors/Classes/BaseMonitor.html#/s:vC13XestiMonitors11BaseMonitor12isMonitoringSb
[bm_start_monitoring]: https://eBardX.github.io/XestiMonitors/Classes/BaseMonitor.html#/s:FC13XestiMonitors11BaseMonitor15startMonitoringFT_Sb
[bm_stop_monitoring]: https://eBardX.github.io/XestiMonitors/Classes/BaseMonitor.html#/s:FC13XestiMonitors11BaseMonitor14stopMonitoringFT_Sb

[bnm_addNotificationObservers]: https://eBardX.github.io/XestiMonitors/Classes/BaseNotificationMonitor.html#/s:FC13XestiMonitors23BaseNotificationMonitor24addNotificationObserversFCSo18NotificationCenterSb
[bnm_cleanupMonitor]: https://eBardX.github.io/XestiMonitors/Classes/BaseNotificationMonitor.html#/s:FC13XestiMonitors23BaseNotificationMonitor14cleanupMonitorFT_Sb
[bnm_configureMonitor]: https://eBardX.github.io/XestiMonitors/Classes/BaseNotificationMonitor.html#/s:FC13XestiMonitors23BaseNotificationMonitor16configureMonitorFT_Sb
[bnm_removeNotificationObservers]: https://eBardX.github.io/XestiMonitors/Classes/BaseNotificationMonitor.html#/s:FC13XestiMonitors23BaseNotificationMonitor27removeNotificationObserversFCSo18NotificationCenterSb