Changelog: Twilio Sync iOS SDK

Latest release: 1.0.0

The latest major release of the Sync SDK for iOS is version 1.0.0. You may download the latest version of the SDK as a tarfile or wire a dependency with CocoaPods:

use_frameworks!
platform :ios, '11.0'

target 'TicTacTwilio' do
   pod 'TwilioSyncClient', '~>1.0'
end

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 v1.0.0 January 19, 2021

• [tarfile]
• sha256: d287322d484d2baa1562e0e589758e0a7aa63abe1e982c6c9806dbae86286f18
• [Documentation]

変更点

• The minimum required iOS version has been bumped to 11.
• Removed deprecated methods.
• Some methods were refactored to properties.
• Added the previous snapshot to be able to compare to events like item was updated or removed. Changes were performed on delegate calls of TWSList, TWSMap, and TWSDocument.
• In-page sorting was removed for pagination calls. Sorting depends on backend output.
• Errors code and descriptions were synchronized between different iOS, Android, and JavaScript SDKs.
• Exposed dateUpdated for all sync objects.
• The SDK now supports HTTP proxy. Proxy is enabled with a new flag useProxy passed to client properties on client creation. Proxy settings are read from the system configuration.
• Added the ability to defer certificate checks to the OS (disable pinning) using a new flag, deferCertificateTrustToPlatform, passed to client properties on client creation.

Sync SDK for iOS v0.8.7 November 5, 2019

• [tarfile]
• [Documentation]

変更点

• Added minimum required iOS version to the start page.
• Fixed a bug that caused an excessive subscription retry loop on failure, which would lead to an increased network and battery consumption.

Sync SDK for iOS v0.8.6 September 24, 2019

• [tarfile]
• [Documentation]

変更点

• Fixed a race condition where some of the delegates could be invoked twice.
• Fixed a crash when attempting to use an already released delegate.
• Fixed a race condition where a callback could be invoked twice for a removed channel.

Sync SDK for iOS v0.8.5 August 29, 2019

• [tarfile]
• [Documentation]

変更点

• Fixed loading of the framework from an extension.

Sync SDK for iOS v0.8.3 June 26, 2019

• [tarfile]
• [Documentation]

変更点

• Improved stability on shutdown, fixed crash issue.

Sync SDK for iOS v0.8.2 June 19, 2019

• [tarfile]
• [Documentation]

変更点

• Fix crash when trying to create a client with nil token.
• Fix numerous stability issues in the client.

Sync SDK for iOS v0.8.1 April 17, 2019

• [tarfile]
• [Documentation]

変更点

• Overhauled transport and communication layer, significantly improving network traffic overhead and client performance
• Improved connection reliability under bad network conditions.
• Fixed unexpected connectivity errors with code 1401: Unable to establish connection to Twilio Sync service.

Sync SDK for iOS v0.7.5 July 3, 2018

• [tarfile]
• [Documentation]

変更点

• TwilioSyncClient now ships with the dSYM package for each release. See the extra debugging information for iOS SDKs documentation for more details. In particular we encourage Crashlytics users to review uploading framework dSYM files and including Twilio SDK version information in our documentation.
• Updates to internal certificate authority trust store.

Sync SDK for iOS v0.7.4 May 17, 2018

• [tarfile]
• [Documentation]

変更点

• Privacy by default in logging for GDPR. A new logging level has been introduced, TWSLogLevelSilent, which is also the new default level. We strongly encourage customers use this logging level for production builds especially if serving European customers.

Sync SDK for iOS v0.7.3 April 26, 2018

• [tarfile]
• [Documentation]

変更点

• Deprecated stream delegate method onStreamRemoved:eventContext: now is called as expected when a stream is removed, please migrate to using the delegate method onStream:removedWithEventContext: for future compatibility.

Sync SDK for iOS v0.7.2 (March 2, 2018)

• [tarfile]
• [Documentation]

変更点

• on*Error methods for entities will no longer be called when a failure to open occurs. The completion handler for such operations is the best way to check for success or failure on open/creation.
• Resolved issue where delegate method parameters marked as nonnull could receive nil objects.
• Resolved issue where remote update delegate calls may not be received.

Sync SDK for iOS v0.7.1 (February 7, 2018)

• [tarfile]
• [Documentation]

変更点

• Updated internal certificate store for upcoming certificate authority changes.

Sync SDK for iOS v0.7.0 (January 17, 2018)

• [tarfile]
• [Documentation]

変更点

Synopsis of enhancements:

• flowId has been deprecated in favor of using the completion blocks already present in the SDK.
• The distinction between remote (for remotely initiated operations) and result (for locally initiated operations) has been transitioned to TWSEventContext's isLocal property. You will receive a call to the now shared delegate methods with this object where it is applicable. For Lists and Maps, local operations previously provided the delegate call with only the index or key for the item – the full item will now be returned for both local and remote operations.
• Documents, Lists (and their items), Maps (and their items) and Streams may now all have an optional max time to live specified. This number is expressed in seconds and is relative to when the TTL is set. After the TTL expires, the object will be destroyed on the backend in the near future. TWSOpenOptions has been expanded to allow specifying a TTL during object creation (this property is ignored when opening preexisting objects.) The TWS*Metadata classes taken as a parameter for some methods on Document, List and Map are optional and can be specified as nil.

Migration tips:

flowID has been removed globally; most places that previously accepted a flowID now accept metadata which can be nil today if you are not specifying a TTL.

Most delegate methods have changed signature. This is important to note since legacy delegate methods will generally not produce any warnings or errors with this change. The individual remote and local delegate methods have been combined into a single delegate method for operations. Delegates which previously received only an index or key will now receive the full value. Most delegate methods now also provide a TWSEventContext object which will indicate whether the operation was locally or remotely initiated.

Update squashing:

Individual local operations will continue to return the status of each operation via their completion block but updates sent to the server may be batched for efficiency. This means remote clients may not see every state update performed individually, but will instead see updates with the object's final updated state.

If you require updates to be treated as individual operations for purposes of notifying remote clients, it is recommended you schedule subsequent updates to occur after the completion of each operation.

Specific changes to classes:

• TWSConstants
  • typedef TWSDuration (NEW)
  • constant TWSDurationInfinity (NEW)
  • block TWSDataMutator no longer takes a flowId parameter (CHANGED)
• TWSOpenOptions
  • - (TWSOpenOptions *)ttl:(TWSDuration)ttl (NEW)
  • - (TWSDuration)ttl (NEW)
• TWSEventContext (NEW)
  • Added to provide context to your delegate about the operation performed. Today, this includes an isLocal property which will return true if the operation was initiated by the local client, false if initiated remotely.
• TWSDocument
  • Added -setTtl:completion: method
  • Removed flowID references, added TWSDocumentMetadata for specifying initial TTL.

• TWSDocumentDelegate
  • Updated delegate methods to remove flowID, added TWSEventContext for methods called as a result of both local and remote operations.

• TWSDocumentMetadata
  • Added to optionally provide initial TTL on Document creation.
• TWSList
  • Added -setTtl:completion: method
  • Added -setTtl:forItemAtIndex:completion: method
  • -setItemWithData:metadata:completion: now accepts a TWSListItemCompletion block instead of TWSCompletion
  • Removed flowID references, added TWSListItemMetadata for specifying TTL for items on add and modification.

• TWSListDelegate
  • Updated delegate methods to remove flowID, added TWSEventContext for methods called as a result of both local and remote operations.

• TWSListItemMetadata
  • Added to optionally provide initial TTL on List Item creation or modification.
• TWSMap
  • Added -setTtl:completion: method
  • Added -setTtl:forItemWithKey:completion: method
  • -setItemWithKey:data:metadata:completion: now accepts a TWSMapItemCompletion block instead of TWSCompletion
  • Removed flowID references, added TWSMapItemMetadata for specifying TTL for items on set and modification.

• TWSMapDelegate
  • Updated delegate methods to remove flowID, added TWSEventContext for methods called as a result of both local and remote operations.

• TWSMapItemMetadata
  • Added to optionally provide initial TTL on Map Item creation or modification.
• TWSStream
  • Added -setTtl:completion: method
  • Removed flowID references.

• TWSStreamDelegate
  • Updated delegate methods to remove flowID, added TWSEventContext for methods called as a result of both local and remote operations.

Sync SDK for iOS v0.6.2 (February 7, 2018)

• [tarfile]
• [Documentation]

変更点

• Updated internal certificate store for upcoming certificate authority changes.

Sync SDK for iOS v0.6.1 (November 22, 2017)

• [tarfile]
• [Documentation]

変更点

• Both Sync client creation and updateToken:completion: once again give feedback if the provided token is expired or otherwise invalid.
• Re-connection to the Sync server will occur faster when bringing the application to the foreground or the device's network connection recovering while in the application.
• Improved completion handler execution if network connection terminates while an operation is in progress.

Sync SDK for iOS v0.6.0 (September 14, 2017)

• [tarfile]
• [Documentation]

変更点

• With the addition of support for iOS 11, we are deprecating support for iOS 8 in Sync iOS 0.6.x.
• Client creation is now asynchronous, with successful client creations being delivered through the TwilioSyncClient syncClientWithToken:properties:delegate:completion:'s completion method.
• tokenUpdate: now provides feedback via a completion method of success or failure.
• Added Steams:
  • New openStreamWithOptions:delegate:completion: method on TwilioSyncClient
  • New TWSStream and TWSStreamMessage objects
  • New TWSStreamDelegate delegate
• Document Changes:
  • Unused onDocument:remoteErrorOccurred: delegate method removed
  • Redundant data parameter removed from delegate calls, data property is available on document which is passed to delegate method already
  • document property of onDocument:resultErrorOccurred: is no longer flagged as nullable, it will always be presented
• List Changes:
  • Unused onList:remoteErrorOccurred: delegate method removed
  • Redundant item index parameter removed from delegate calls, index property is available on item which is passed to delegate method already
  • Deleted list item is now passed to onList:remoteItemRemoved: instead of index
  • list property of onList:resultErrorOccurred: is no longer flagged as nullable, it will always be presented
• Map Changes:
  • Unused onMap:remoteErrorOccurred: delegate method removed
  • Redundant item key parameter removed from delegate calls, key property is available on item which is passed to delegate method already
  • Deleted map item is now passed to onMap:remoteItemRemoved: instead of key
  • map property of onMap:resultErrorOccurred: is no longer flagged as nullable, it will always be presented
• OpenOptions Changes:
  • Added synchronizationStrategy: declaration, allows specifying of synchronization strategy.
• Completion blocks now include nullability hints for return values and parameters

Sync SDK for iOS v0.5.0 (June 21, 2017)

• [tarfile]
• [Documentation]

変更点

• Introduced TWSTwilioClientCompletion as a parameter to client creation. Clients are no longer created as immediate returns, instead the completion block is called when the client is available and ready for use.
• updateToken accepts a completion block now to indicate the success or failure of the token update operation.
• Added optional TWSSynchronizationStrategy (with values TWSSynchronizationStrategyDefault and TWSSynchronizationStrategyAggressive) to TWSOpenOptions.
• Remotely changed items within Maps no longer are notified via a single set delegate method but instead distinct added and updated delegate methods to convey which operation occurred.
• Sync SDK log output is now prefixed with TWSY for easier evaluation of logs
• Deprecation of distinct uniqueName accessor on TWSOpenOptions - the set value will be available via the sidOrUniqueName accessor

Sync SDK for iOS v0.2.0 (March 16, 2017)

• [tarfile]
• [Documentation]

変更点

• 同一プロジェクト内の他のTwilio SDKとの非互換性が生じる可能性が解決されました
• Updated framework signing for AppStore compatibility
• The endpoint_id identifier specified in access tokens is now automatically generated and persisted in the keychain. The following should be observed with this change:
  • endpoint_id is no longer a required identifier in your generated access tokens, you may omit it from this build forward
  • endpoint_id がアクセストークンに指定されると無視されるようになりました
  • When running in the iOS simulator only, the automatically generated endpoint_id may not persist between runs to the simulator keychain without this [work-around]
• クライアントが無効なアクセストークンを伴って最初に作成される場合、それは失敗しクライアントのインスタンスにはnilが返されるようになりました
• Added new error callback to SyncClient: - (void)syncClient:(nonnull TwilioSyncClient *)client errorReceived:(nonnull TWSError *)error; will be called in case of client failures, for example when using an invalid access token.
• セキュリティーの向上