repository·master·Indexed 25 days ago
https://github.com/parse-community/parse-sdk-ios-osxA library providing access to the Parse Server backend for Apple platforms, including iOS, iPadOS, macOS, watchOS, and tvOS. Compatible with Parse Server version 1.0.0 and later, the SDK supports real-time updates via PFLiveQueryClient and is installable via Swift Package Manager.
The easiest way to install the SDK is using Swift Package Manager (SPM). Follow these steps in Xcode:
https://github.com/parse-community/Parse-SDK-iOS-OSXhttps://github.com/parse-community/Parse-SDK-iOS-OSXThe SDK follows the annual Xcode release schedule, supporting the current and previous major Xcode versions. Refer to the compatibility matrix below for specific SDK version requirements based on your environment:
| Xcode Version | iOS Version | macOS Version | watchOS Version | tvOS Version | Parse Apple SDK Support |
|---|---|---|---|---|---|
| Xcode 13 | iOS 15 | macOS 12 | watchOS 8 | tvOS 15 | >= 1.19.3 < 2.7.2 |
| Xcode 14 | iOS 16 | macOS 13 | watchOS 9 | tvOS 16 | >= 2.7.2 < 5.0.0 |
| Xcode 15 | iOS 17 | macOS 14 | watchOS 10 | tvOS 17 | >= 3.0.0 <= 5.1.1 |
| Xcode 16 | iOS 18 | macOS 15 | watchOS 11 | tvOS 18 | >= 4.2.0 |
| Xcode 26 | iOS 26 | macOS 26 | watchOS 26 | tvOS 26 | >= 6.2.0 |
You can initialize a Client (exposed as PFLiveQueryClient in Objective-C) in two ways:
init() to create a client that automatically uses the server, application ID, and client key from Parse.currentConfiguration().initWithServer:applicationId:clientKey: to connect to a specific WebSocket server URL with custom credentials.Note that the server URL will be automatically converted to use the ws or wss scheme.
To receive real-time updates for specific data changes, use the subscribe method on a Client instance. You can provide a PFQuery and a handler that conforms to SubscriptionHandling to process incoming updates.
subscribe(_:subclassType:): Registers a query using a default subscription handler.subscribe(_:handler:): Registers a query with a custom handler for fine-grained control over update events.You can stop receiving updates by unsubscribing. You can unsubscribe from all updates for a specific query, or target a specific query-handler pair.
unsubscribe(_:): Unsubscribes all current subscriptions for a given PFQuery.unsubscribe(_:handler:): Unsubscribes a specific handler from a specific query.Client provides a shared static property that acts as a singleton. This is useful for managing default subscriptions across your application. If a shared client hasn't been initialized, accessing it will automatically create one using the current Parse configuration.The Client allows manual control over the WebSocket connection:
reconnect(): Reconnects the client to the server. This will automatically disconnect the current socket and resubscribe all existing subscriptions. This is recommended when an error occurs.disconnect(): Explicitly disconnects the client. This does not remove existing subscriptions; calling reconnect() later will restore them. Use this to dispose of the client.update(_:toQuery:) method. This updates the existing subscription on the server and triggers the handler with the new query context.