A non-blocking Swift module for sending remote Apple Push Notification requests to APNS built on AsyncHttpClient.
- Installation
- Getting Started
- Sending a simple notification
- Sending Live Activity Update
- Authentication
- Logging
- Server Example
- iOS Examples
- Original pitch and discussion on API
To install APNSwift, just add the package as a dependency in your Package.swift.
dependencies: [
.package(url: "https://github.com/swift-server-community/APNSwift.git", from: "5.0.0"),
]APNSwift aims to provide semantically correct structures to sending push notifications. You first need to setup a APNSClient. To do that youll need to know your authentication method
let client = APNSClient(
configuration: .init(
authenticationMethod: .jwt(
privateKey: try .init(pemRepresentation: privateKey),
keyIdentifier: keyIdentifier,
teamIdentifier: teamIdentifier
),
environment: .sandbox
),
eventLoopGroupProvider: .createNew,
responseDecoder: JSONDecoder(),
requestEncoder: JSONEncoder(),
byteBufferAllocator: .init(),
backgroundActivityLogger: logger
)
defer {
client.shutdown { _ in
logger.error("Failed to shutdown APNSClient")
}
}All notifications require a payload, but that payload can be empty. Payload just needs to conform to Encodable
struct Payload: Codable {}
try await client.sendAlertNotification(
.init(
alert: .init(
title: .raw("Simple Alert"),
subtitle: .raw("Subtitle"),
body: .raw("Body"),
launchImage: nil
),
expiration: .immediately,
priority: .immediately,
topic: "com.app.bundle",
payload: Payload()
),
deviceToken: "device-token",
deadline: .nanoseconds(Int64.max),
logger: myLogger
)It requires sending ContentState matching with the live activity configuration to successfully update activity state. ContentState needs to conform to Encodable
try await client.sendLiveActivityNotification(
.init(
expiration: .immediately,
priority: .immediately,
appID: "com.app.bundle",
contentState: ContentState,
event: .update,
timestamp: Int(Date().timeIntervalSince1970)
),
activityPushToken: activityPushToken,
deadline: .distantFuture
) try await client.sendLiveActivityNotification(
.init(
expiration: .immediately,
priority: .immediately,
appID: "com.app.bundle",
contentState: ContentState,
event: .end,
timestamp: Int(Date().timeIntervalSince1970),
dismissalDate: .dismissImmediately // Optional to alter default behaviour
),
activityPushToken: activityPushToken,
deadline: .distantFuture
)APNSwift provides two authentication methods. jwt, and TLS.
jwt is preferred and recommend by Apple
These can be configured when created your APNSClientConfiguration
Notes: jwt requires an encrypted version of your .p8 file from Apple which comes in a pem format. If you're having trouble with your key being invalid please confirm it is a PEM file
openssl pkcs8 -nocrypt -in /path/to/my/key.p8 -out ~/Downloads/key.pem
By default APNSwift has a no-op logger which will not log anything. However if you pass a logger in, you will see logs.
There are currently two kinds of loggers.
This logger can be passed into the APNSClient and will log background things like connection pooling, auth token refreshes, etc.
This logger can be passed into any of the send: methods and will log everything related to a single send request.
Take a look at Program.swift
For an iOS example, open the example project within this repo.
Once inside configure your App Bundle ID and assign your development team. Build and run the ExampleApp to iOS Simulator, grab your device token, and plug it in to server example above. Background the app and run Program.swift
- Pitch discussion: Swift Server Forums
- Proposal: SSWG-0006
- 5.0 breaking changings: [Swift Server Forums](Blog post here on breaking changing)