Changelog: Twilio Sync iOS SDK

If you are interested in Mac Catalyst support, please contact support to get hands-on experience with it.

End-of-Life for versions 0.2.0 and below begins on April 10, 2022. Functionality will cease to work properly for these versions. Please upgrade to the latest version.

Support for 1.x will cease on April 3, 2024. Please upgrade to the latest version.

Latest release: 2.0.2

The latest release of the Sync SDK for iOS is version 2.0.2. You may download the latest version of the SDK as an Archive or integrate it as a project dependency with CocoaPods or Swift Package Manager.

CocoaPods

To install the SDK using CocoaPods, add the following to your Podfile, changing MyTarget to the name of your target:

use_frameworks!
platform :ios, '13.0'

target 'MyTarget' do
  pod 'TwilioSyncClient', '~>2.0'
end

Swift Package Manager

To install the SDK using Swift Package Manager, follow these steps:

Open your project in Xcode.
Select File > Swift Packages > Add Package Dependency....
Enter https://github.com/twilio/twilio-sync-ios into the search field in the Choose Package Repository: dialog, then click Next.
Make your versioning choice and click Next.
Add the package to one of your targets and click Finish.

Version history and changelog

Links are provided to specific patch versions here. We don’t recommend using these links unless you have a specific need for a certain patch.

Sync SDK for iOS v2.0.2 (May 17, 2023)

Archive
sha256: d9969a26757b642b6aee86849e22f9c8cd1c764d2275178dc0816625ac8ab170
Documentation

Old Method	New Method
`-setData:flowId:completion:`	`-setData:metadata:completion:`
`-mutateDataWith:flowId:completion:`	`-mutateDataWith:metadata:completion:`
`-removeDocumentWithFlowId:completion:`	`-removeDocumentWithCompletion:`
	`-setTtl:completion:` (NEW)

Old Method	New Method
`-onDocumentResultOpened:`	`-onDocumentOpened:`
`-onDocument:resultRemovedForFlowID:` `-onDocumentRemoteRemoved:`	`-onDocumentRemoved:eventContext:`
`-onDocumentResultUpdated:forFlowID:` `-onDocumentRemoteUpdated:`	`-onDocument:updated:eventContext:`
`-onDocument:resultErrorOccurred:forFlowID:`	`-onDocument:errorOccurred:`

Old Method	New Method
`-addItemWithData:flowId:completion:`	`-addItemWithData:metadata:completion:`
`-getItemAtIndex:flowId:completion:`	`-getItemAtIndex:completion:`
`-setItemWithData:flowId:completion:`	`-setItemWithData:metadata:completion:`
`-mutateItemAtIndex:mutator:flowId:completion:`	`-mutateItemAtIndex:mutator:metadata:completion:`
`-removeItemAtIndex:flowId:completion:`	`-removeItemAtIndex:completion:`
`-removeListWithFlowId:completion:`	`-removeListWithCompletion:`
	`-setTtl:completion:` (NEW)
	`-setTtl:forItemAtIndex:completion:` (NEW)

Old Method	New Method
`-onListResultOpened:`	`-onListOpened:`
`-onList:resultItemAddedAtIndex:forFlowID:` `-onList:remoteItemAdded:`	`-onList:itemAdded:eventContext:`
`-onList:resultItemRemovedAtIndex:forFlowID:` `-onList:remoteItemRemoved:`	`-onList:itemRemoved:eventContext:`
`-onList:resultItemUpdatedAtIndex:forFlowID:` `-onList:remoteItemUpdated:`	`-onList:itemUpdated:eventContext:`
`-onList:resultCollectionRemovedForFlowID:` `-onListRemoteCollectionRemoved:`	`-onList:collecionRemovedWithEventContext:`
`-onList:resultErrorOccurred:forFlowID:`	`-onList:errorOccurred:`

Old Method	New Method
`-getItemWithKey:flowId:completion:`	`-getItemWithKey:completion:`
`-setItemWithKey:data:flowId:completion:`	`-setItemWithKey:data:metadata:completion:`
`-mutateItemWithKey:mutator:flowId:completion:`	`-mutateItemWithKey:mutator:metadata:completion:`
`-removeItemWithKey:flowId:completion:`	`-removeItemWithKey:completion:`
`-removeMapWithFlowId:completion:`	`-removeMapWithCompletion:`
	`-setTtl:completion:` (NEW)
	`-setTtl:forItemWithKey:completion:` (NEW)

Old Method	New Method
`-onMapResultOpened:`	`-onMapOpened:`
`-onMap:resultItemSetWithKey:forFlowID:` (for adds) `-onMap:remoteItemAdded:`	`-onMap:itemAdded:eventContext:`
`-onMap:resultItemSetWithKey:forFlowID:` (for updates) `-onMap:remoteItemUpdated:`	`-onMap:itemUpdated:eventContext:`
`-onMap:resultItemRemovedWithKey:forFlowID:` `-onMap:remoteItemRemovedWithKey:`	`-onMap:itemRemovedWithKey:eventContext:`
`-onMap:resultErrorOccurred:forFlowID:`	`-onMap:errorOccurred:`
`-onMap:resultCollectionRemovedForFlowID:` `-onMapRemoteCollectionRemoved:`	`-onMap:collecionRemovedWithEventContext:`

Old Method	New Method
`-publishMessageWithData:flowId:completion:`	`-publishMessageWithData:completion:`
`-removeStreamWithFlowId:completion:`	`-removeStreamWithCompletion:`
	`-setTtl:completion:` (NEW)

Old Method	New Method
`-onStreamResultOpened:`	`-onStreamOpened:`
`-onStream:resultMessagePublished:forFlowID:` `-onStream:remoteMessagePublished:`	`-onStream:messagePublished:eventContext:`
`-onStream:resultRemovedForFlowID:` `-onStreamRemoteRemoved:`	`-onStreamRemoved:eventContext:`
`-onStream:resultErrorOccurred:forFlowID:`	`-onStream:errorOccurred:`

Need some help?

Thank you for your feedback!

Thanks for your feedback!