https://github.com/kiliankoe/pushover
📌 Pushover API Wrapper in Swift
https://github.com/kiliankoe/pushover
push-notifications pushover
Last synced: about 1 year ago
JSON representation
📌 Pushover API Wrapper in Swift
- Host: GitHub
- URL: https://github.com/kiliankoe/pushover
- Owner: kiliankoe
- License: mit
- Created: 2017-02-01T14:12:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-03T16:50:51.000Z (over 1 year ago)
- Last Synced: 2025-03-25T07:48:46.594Z (over 1 year ago)
- Topics: push-notifications, pushover
- Language: Swift
- Homepage:
- Size: 85 KB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 📌 Pushover
Simple little wrapper for the [Pushover](https://pushover.net) API. Use it to send push notifications from your tools to your or your user's devices.
## Example
```swift
// Create a pushover object with your API token.
let pushover = Pushover(token: "<#API_TOKEN#>")
// Send a simple message directly.
try await pushover.send("Lorem ipsum dolor sit amet.", to: "<#USER_OR_GROUP_KEY#>")
// Use `Notification`s to use more of Pushover's features.
let notification = Notification(message: "Lorem ipsum.", to: "<#USER#>")
.devices(["iPhone"])
.url("https://example.com")
.urlTitle("Dolor sit amet")
.priority(.high)
.sound(.intermission)
do {
let response = try await pushover.send(notification)
// The request might still have failed due to a wrong API token, exceeded limits or
// other problems. Be sure to check the response value for more information.
} catch {
// An error case means that there was a network, server or decoding error.
}
```
## Requirements
You're going to need an API token, you can register for one [here](https://pushover.net/apps/build).
Also please read the *[Being Friendly to our API](https://pushover.net/api#friendly)* section in the Pushover API docs.
## Installation
Pushover is available via Swift Package Manager.
Package.swift:
```swift
.package(url: "https://github.com/kiliankoe/pushover", from: "<#latest#>")
```
## Contributors
- Kilian Koeltzsch, [@kiliankoe](https://github.com/kiliankoe)
- Sören Gade, [@sgade](https://github.com/sgade)
## License
Pushover is available under the MIT license. See the LICENSE file for more info.