APNSwift Documentation

By default, APNSwift uses a no-op logger. To enable logging, pass a logger instance to the appropriate location:

1. Background Activity Logger: Pass this into the APNSClient to log background operations like connection pooling and auth token refreshes.
2. Notification Send Logger: Pass this into any of the send: methods to log details related to a specific single send request.

Add APNSwift as a dependency in your Package.swift file. Use the following dependency declaration to include the package:

dependencies: [
    .package(url: "https://github.com/swift-server-community/APNSwift.git", from: "6.0.0"),
]

Apple recommends using jwt authentication. This requires an encrypted version of your .p8 file in pem format. If you have a standard .p8 file, you can convert it using OpenSSL:

openssl pkcs8 -nocrypt -in /path/to/my/key.p8 -out ~/Downloads/key.pem

Pass the resulting PEM representation, your keyIdentifier, and teamIdentifier to the APNSClientConfiguration.

To send notifications, you must first set up an APNSClient. This requires an APNSClientConfiguration specifying your authentication method (e.g., .jwt) and the environment (e.g., .development). You also need to provide an eventLoopGroupProvider, a responseDecoder, and a requestEncoder. Remember to call try await client.shutdown() when the client is no longer needed to clean up resources.

let client = APNSClient(
    configuration: .init(
        authenticationMethod: .jwt(
            privateKey: try .init(pemRepresentation: privateKey),
            keyIdentifier: keyIdentifier,
            teamIdentifier: teamIdentifier
        ),
        environment: .development
    ),
    eventLoopGroupProvider: .createNew,
    responseDecoder: JSONDecoder(),
    requestEncoder: JSONEncoder()
)

// Shutdown the client when done
try await client.shutdown()

You can send notifications by calling sendAlertNotification. This method requires a deviceToken and a notification object. The notification object includes an alert (containing title, subtitle, and body), expiration, priority, topic (your app's bundle ID), and a payload. The payload can be any type that conforms 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"
)