Changelog: Twilio Chat iOS SDK
We intend to sunset the Programmable Chat API on July 25, 2022 to focus on the next generation of chat: the Twilio Conversations API. Find out about the EOL process. We have also prepared this Migration Guide to assist in the transition from Chat to Conversations.
Latest release: Chat iOS SDK v5.0.0
We recommend referencing the links below in your projects. As we patch bugs, these links will automatically be updated with fixes.
- CocoaPods
pod 'TwilioChatClient', '~> 5.0' - Swift Package Manager
https://github.com/twilio/twilio-chat-ios - Downloadable .xcframework File
- SDK Documentation
If you need help installing these frameworks in your project, see our installation guidance.
The Chat iOS SDK is unavailable via Carthage because we require support for binary XCFramework files.
If you are interested in Mac Catalyst support, please contact support to get hands-on experience with it.
Support for Previous Versions of the Chat SDKs
Twilio Programmable Chat SDKs use Semantic Versioning. Twilio supports version N-1 for 12 months after the first GA release of version N. We recommend that you upgrade to the latest version as soon as possible to avoid any breaking changes. Version 5.x is the latest iOS version.
Support for 4.x will cease on May 17, 2022. Please upgrade to the latest version.
Support for 3.x will cease on July 20, 2021. Please upgrade to the latest version.
Support for 2.x ceased on March 6, 2021. Please upgrade to the latest version.
End-of-Life for 1.x occured on June 30, 2019. Please upgrade to the latest version.
Changelogs
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 of a release.
Programmable Chat iOS 5.0.0 (May 17, 2021)
* Archive (sha256 638a8136b2eb226e43342b30e70bc80c8e5b6f917bc9c86a45c942dbd5d8686b)
* Docs
Breaking changes
- Major under-the-hood improvement (the “Sessionless” protocol).
This improvement is designed primarily for improved reliability. While this is not a breaking code change, it does carry a meaningful impact on timing:
- SDK commands will return success or failure up to ~10% more quickly than before.
- Real-time updates of data are now likely to arrive after the command completes.
For example,[TCHChannel setAttributes]will invoke completion (i.e., success) while[TCHChannel attributes]still returns the old value. To see the new value, we recommend waiting for an update event, e.g., in thechatClient:channel:updated:TCHChannelUpdateAttributesdelegate.
- The channel list page size increased from 50 to 100. Please make sure your code respects any returned page size, rather than assuming 50 (or 100).
- Some error messages have changed:
- Declining an invite while already joined will return an error
50601, Invite not foundinstead of50602, Cannot decline invite when already channel member. - Trying to leave a channel you're not part of will return error
50402, Member not foundinstead of50400, User not member of channel.
- Declining an invite while already joined will return an error
Programmable Chat iOS 4.2.1 (April 22, 2021)
Changes
- Fixed setting queue from properties.
- Fixed an issue when a connection could be not established after returning from background. The issue was introduced in 4.1.0 and users are highly encouraged to upgrade to this version to avoid disconnection problems.
Programmable Chat iOS 4.2.0 (March 23, 2021)
Changes
- Added possibility to set dispatch queue to get reports not from main queue, but from selected one.
- Added support for XCFrameworks with arm64 simulator.
- Added support for SPM.
- Removed support of Carthage until it supports binary XCFrameworks.
- Fixed an issue when connection could be not established after returning from background.
Programmable Chat iOS 4.1.0 (January 29, 2020)
Changes
- The SDK now supports HTTP proxy. Proxy is enabled with a new flag
useProxypassed 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.
Known issues
TCHUserUpdateReachabilityOnlineandTCHUserUpdateReachabilityNotifiableevents could not come sometimes.
Programmable Chat iOS 4.0.2 (November 13, 2020)
Changes
- Fixed a bug when
onChannelDeleteddoesn't come for private Channel when Member removed by other user. - Fixed a bug which could lead to client synchronisation stuck.
- Fixed a crash on accessing
memberWithIdentityfrom multiple threads.
Programmable Chat iOS 4.0.1 (October 21, 2020)
Changes
- Fixed a bug which could lead to crashes on member attributes update.
Programmable Chat iOS 4.0.0 (July 20, 2020)
Breaking changes
- Renamed
TCHMessageaccessor:timestampasdateCreated;timestampAsDateasdateCreatedAsDate. - Asynchronous
[TCHMembers membersWithCompletion]transformed to synchronous[TCHMembers membersList]. - Added
TCHMemberUpdateLastConsumptionTimestamp.- This as a result also changed value of
TCHMemberUpdateAttributes, potentially a silent breaking change if this value was serialized.
- This as a result also changed value of
- Changed TWSMap/TWSList
queryItemsWithOptionsto return error in completion ifpageSizeis 0. - Changed
[TCHChannel getUnconsumedMessagesCountWithCompletion]to return nil instead of 0 if message consumption horizon was not set.- Completion now uses
NSNumber*(nullable object type), instead of NSUInteger to accommodate this change.
- Completion now uses
- Changed
[TCHMessages setNoMessagesConsumedWithCompletion]to use nullableNSNumber*, it will always return nil (because it resets the consumption horizon).
Changes
- Added
[TCHMessage getMediaContentTemporaryUrlWithCompletion]to get a temporary direct link to Media content. - To download Media by direct URL, use native iOS API, such as
[NSData dataWithContentsOfURL()]. - Deprecated
[TCHMessage getMediaWithOutputStream:...]. Use above API instead.
Programmable Chat iOS 3.1.1 (June 1, 2020)
Changes
- Fixed the bug when connection is dropped with message: "The WebSocket message exceeded the locally configured limit".
Programmable Chat iOS 3.1.0 (May 20, 2020)
This version has been deprecated June 1, please use 3.1.1.
Changes:
- Added ability to specify custom command timeout for operations like send message, join to a channel, etc.
Programmable Chat iOS 3.0.2 (April 2, 2020)
This version was deprecated June 1, 2019, please use 3.1.1.
Changes
- Fixed an issue when the same state comes to
[TwilioChatClient chatClient:connectionStateUpdated:]. - Improved stability on shutdown, fixed crash issues.
Programmable Chat iOS 3.0.1 (March 12, 2020)
Changes
- Restored missing
CFBundleVersionandCFBundleShortVersionStringin theInfo.plistof the framework, which fixes exporting app archives to AppStore.
Programmable Chat iOS 3.0.0 (March 6, 2020)
Breaking changes
- Dropped iOS v9, v10 support. Minimum iOS version now is 11.0
- Added type-safe interface
TCHJsonAttributesfor Attributes (TCHChannel,TCHMessage,TCHMember,TCHUser). Now it supports not only Json Object, which was translated toNSDictionary, but alsoNSArray,NSString,NSNumber,NSNull.
Changes
- Fixed a bug when channel attributes are empty when
chatClient:channelAdded:called. - Fixed an issue when sometimes connecting events don’t arrive.
- Fixed incorrect behaviour when user identity contained some special symbols.
- New type of error
TCHClientConnectionStateFatalErrorcould appear in some cases. This error means chat is in a terminal state, and needs to re-create the client.
2.X
For older changelog entries including 2.x, see the 2.x Changelog.
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting our Twilio Community forums or browsing the Twilio tag on Stack Overflow.