Skip to content

kiliankoe/pushover

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

64 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“Œ Pushover

Simple little wrapper for the Pushover API. Use it to send push notifications from your tools to your or your user's devices.

Example

// 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.

Also please read the Being Friendly to our API section in the Pushover API docs.

Installation

Pushover is available via Swift Package Manager.

Package.swift:

.package(url: "https://github.com/kiliankoe/pushover", from: "<#latest#>")

Contributors

License

Pushover is available under the MIT license. See the LICENSE file for more info.

About

๐Ÿ“Œ Pushover API Wrapper in Swift

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  

Languages