We recommend using these links in your projects. As we patch bugs, these links will automatically be updated with the fixes.
Previous legacy versions
Programmable Chat is now in GA. A number of breaking changes were introduced as part of the GA release. To see what has changed and to migrate from the latest Beta SDK to the new GA SDK, please read the GA Migration Guide for iOS.
Programmable Chat is the new name of what was previously called IP Messaging. If you are an existing IP Messaging user, you will want to follow the Migration Guide for iOS.
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.
- Privacy by default in logging for GDPR. A new logging level has been introduced,
TCHLogLevelSilent, which is also the new default level. We strongly encourage customers use this logging level for production builds especially if serving European customers.
- Fix for crashes related to logging while the chat client was being disposed.
- Fix for crashes related to delegate events while the chat client was being disposed.
- Fix for notifications where channel SID would sometimes be invalid.
- Addressed possible issue where the Chat Client is disposed during startup.
- Addressed issue where Access Manager could try to call methods on disposed delegate objects.
- Resolved issue where passing nil to push token method parameters could lead to a crash.
- Resolved issue where user parameter returned by TCHUserDescriptor's subscribe method could be nil.
- Resolved potential memory leak when uploading media.
- Added static helper methods for evaluating token expiry:
+ (BOOL)isExpired:(nonnull NSString *)token+ (BOOL)isExpiring:(nonnull NSString *)token
- Resolved an issue with some identities containing '?' resulting in not getting token expiry events
- Dates would sometimes not parse correctly for some locales depending on the date format, resulting in
nil date objects – they parse consistently now.
- The
body attribute of messages containing media included the placeholder message intended for legacy client versions, potentially incorrectly inferring the client version did not support media attachments. body will now be nil if the TCHMessage has media content.
- Expanded callbacks delivered from
TwilioChatClient to support three new notifications:
- Added to channel notification:
- (void)chatClient:(nonnull TwilioChatClient *)client notificationAddedToChannelWithSid:(nonnull NSString *)channelSid
- Invited to channel notification:
- (void)chatClient:(nonnull TwilioChatClient *)client notificationInvitedToChannelWithSid:(nonnull NSString *)channelSid
- Removed from channel notification:
- (void)chatClient:(nonnull TwilioChatClient *)client notificationRemovedFromChannelWithSid:(nonnull NSString *)channelSid;
chatClient:notificationNewMessageReceivedForChannelSid:messageIndex: now consistently returns message index when a new message is received.- Added
.sid identifier to TCHMember objects.
- BEHAVIORAL CHANGE: Bug-fix for calling TCHChannel's
joinWithCompletion: or TCHMember's addByIdentity:completion: will now correctly return with a failure result if the user/identity is already a member of the channel instead of success.
- Updating the consumption horizon now provides the updated unconsumed message count.
The following methods have been deprecated and for now have the same effect as passing null/nil to the optional completion parameters introduced below:
- (void)setLastConsumedMessageIndex:(nonnull NSNumber *)index;
- (void)advanceLastConsumedMessageIndex:(nonnull NSNumber *)index;
- (void)setAllMessagesConsumed;
- (void)setNoMessagesConsumed;
These methods are replaced with versions that take an optional completion block:
- (void)setLastConsumedMessageIndex:(nonnull NSNumber *)index completion:(nullable TCHCountCompletion)completion;
- (void)advanceLastConsumedMessageIndex:(nonnull NSNumber *)index completion:(nullable TCHCountCompletion)completion;
- (void)setAllMessagesConsumedWithCompletion:(nullable TCHCountCompletion)completion;
- (void)setNoMessagesConsumedWithCompletion:(nullable TCHCountCompletion)completion;
The completion block will convey the newly updated unread message count for the channel for the current user.
These operations will also affect the value returned by TCHChannel's getUnconsumedMessagesCountWithCompletion: method, causing the value returned by it to be up to date as of the consumption update the user just performed.
- Both chat client creation and
updateToken:completion: once again give feedback if the provided token is expired or otherwise invalid.
- Re-connection to the chat server will occur faster when bringing the application to the foreground or the device's network connection recovering while in the application.
- Fixed an issue where the completion for
joinChannel sometimes was not called.
- Fixed an issue where properties of
TCHMessage were sometimes not fully populated by the time sendMessage's completion was called.
- Fixed an infrequently occurring crash on chat client startup.
Important: The behavior of not-present optional data, such as friendlyName, uniqueName, etc, has changed with this release of Programmable Chat iOS to match the REST API and improve usability in Swift. We no longer return an empty string on missing data, returning instead nil. If you are relying on the previous behavior of empty string to be able to directly display these values in your application, you will need to check for the value instead.
With 2.x, we are moving Programmable Chat iOS releases to the global CocoaPods repository. We will no longer be posting non-beta releases for this SDK to the https://github.com/twilio/cocoapod-specs/ location. If you already have the global CocoaPods source in your Podfile no changes are necessary. If you do not have it, you will need to add source 'https://github.com/cocoapods/specs' or remove the Twilio specific source line. No changes are necessary if you use manual integration of this SDK.
- Added Multimedia Messaging (beta) API (see Media Support for more information). Note: Sending media messages on existing instances requires adding a new permission in your channel roles.
- With the addition of support for iOS 11, we are deprecating support for iOS 8 in Programmable Chat iOS 2.x
chatClient:channel:updated: will no longer notify on TCHChannelUpdateSynchronizationStatus changes - see the chatClient:channel:synchronizationStatusUpdated: delegate call for these updates- Creation of new messages is no longer a two-step process,
createMessageWithBody: is deprecated from TCHMessages. You now build a new message using the TCHMessageOptions object and send with sendMessageWithOptions:completion:
Old:
TCHMessage *message = [channel.messages createMessageWithBody:@"hello"];
[channel.messages sendMessage:message completion:^(TCHResult *result) { }];
New:
TCHMessageOptions *options = [[TCHMessageOptions new] withBody:@"hello"];
[channel.messages sendMessageWithOptions:options completion:^(TCHResult *result, TCHMessage *message) { }];
- Nullability hints and behavior have changed for the sdk. SDK methods will accept either nil or an empty string as an argument for clearing data but will consistently return nil when there is no data set for an optional field to improve usability. This applies to dates and user, channel and message attributes as well.
Changes to nullability hints throughout entire public interface.
- TCHChannelUpdateSynchronizationStatus (REMOVED - see
chatClient:channel:synchronizationStatusUpdated:)
- TCHMessageTypeText
- TCHMessageTypeMedia
- messageType (ADDED)
- mediaSid (ADDED)
- mediaSize (ADDED)
- mediaType (ADDED)
- mediaFilename (ADDED)
- -hasMedia (ADDED)
- -getMediaWithOutputStream:onStarted:onProgress:onCompleted:completion: (ADDED)
- -createMessageWithBody: (REMOVED)
- -sendMessage:completion: migrated to -sendMessageWithOptions:completion: - completion now provides a handle to the new TCHMessage
With 1.x, we are moving Access Manager releases to the global CocoaPods repository. We will no longer be posting non-beta releases for this SDK to the https://github.com/twilio/cocoapod-specs/ location. If you already have the global CocoaPods source in your Podfile no changes are necessary. If you do not have it, you will need to add source 'https://github.com/cocoapods/specs' or remove the Twilio specific source line. No changes are necessary if you use manual integration of this component.
- Updated internal certificate store for upcoming certificate authority changes.
- Both chat client creation and
updateToken:completion: once again give feedback if the provided token is expired or otherwise invalid.
- Re-connection to the chat server will occur faster when bringing the application to the foreground or the device's network connection recovering while in the application.
- Fixed an issue where the completion for
joinChannel sometimes was not called.
- Fixed an issue where properties of
TCHMessage were sometimes not fully populated by the time sendMessage's completion was called.
- Resolved issue when updating token on chat client after token expiry.
- Performance enhancements
- Resolved possible crash during client creation if initialization takes an especially long time
- Completion handler for TCHChannel's
join method will be delayed until the channel is fully synchronized, guaranteeing availability of members and messages objects.
- Fixed issues related to thread management, which in many cases should lead to significant performance gains.
- Fixed crashes possible during client shutdown.
- Fix bug where TCHChannel’s
chatClient:channel:synchronizationStatusUpdated: delegate method was not called.
- Added channel synchronization status method to chat client delegate.
- Trigger channel’s synchronization status delegate method every time a channel delegate is assigned for convenience.
- Resolved issue where TCHMessages'
getLastMessagesWithCount:completion: could hang.
- Fixed a bug whereby client initialization did not completed correctly - i.e. no success nor failure callback was received for client creation. This was for cases not fixed in the previous release.
- Fixed an issue whereby the SDK could crash in some cases when creating a new Chat Client instance.
- Fixed a bug whereby client initialization did not completed correctly - i.e. no success nor failure callback was received for client creation
- Fixed a bug whereby some commands did not correctly complete - i.e. no success callback nor failure was received
- Fixed a bug whereby after a call to the client's
shutdown sometimes caused New Message push registrations to be lost for the endpoint.
- userInfo migrated to user
- chatClientWithToken:properties:delegate: migrated to chatClientWithToken:properties:delegate:completion:
- updateToken: migrated to updateToken:completion:
- users (ADDED)
- registerWithToken: migrated to registerWithNotificationToken:completion:
- deregisterWithToken: migrated to deregisterWithNotificationToken:completion:
- handleNotification: migrated to handleNotification:completion:
- synchronizationStrategy (REMOVED)
- initialMessageCount (REMOVED)
- chatClient:connectionStateChanged: renamed to chatClient:connectionStateUpdated:
- chatClient:synchronizationStateChanged: renamed to chatClient:synchronizationStateUpdated:
- chatClient:channelChanged: migrated to chatClient:channel:updated:
- chatClient:channel:synchronizationStatusChanged:
- chatClient:channel:memberChanged: renamed to chatClient:channel:member:updated:
- chatClient:channel:messageChanged: migrated to chatClient:channel:message:updated:
- chatClientToastSubscribed: (REMOVED)
- chatClient:toastRegistrationFailedWithError: (REMOVED)
- chatClient:toastReceivedOnChannel:message: migrated to chatClient:notificationNewMessageReceivedForChannelSid:messageIndex:
- chatClient:user:updated: (ADDED)
- chatClient:userSubscribed: (ADDED)
- chatClient:userUnsubscribed: (ADDED)
- synchronizeWithCompletion: (REMOVED)
- chatClient:channelChanged: migrated to chatClient:channel:updated:
- chatClient:channel:synchronizationStatusChanged: renamed to chatClient:channel:synchronizationStatusUpdated:
- chatClient:channel:memberChanged: renamed to chatClient:channel:member:updated:
- chatClient:channel:messageChanged: migrated to chatClient:channel:message:updated:
- chatClient:channel:member:userInfo:updated: migrated to chatClient:channel:member:user:updated:
- chatClient:channel:member:userSubscribed: (ADDED)
- chatClient:channel:member:userUnsubscribed: (ADDED)
- userChannelsWithCompletion: (REMOVED)
- subscribedChannels (ADDED)
- userChannelDescriptorsWithCompletion: (ADDED)
- publicChannelsWithCompletion: renamed to publicChannelDescriptorsWithCompletion:
- TCHChannelStatusUnknown (ADDED)
- userInfo migrated to identity
- userDescriptorWithCompletion: (ADDED)
- subscribedUserWithCompletion: (ADDED)
- resultCode (ADDED)
- resultText (ADDED)
- userDescriptorsForChannel:completion:
- userDescriptorWithIdentity:completion:
- subscribedUserWithIdentity:completion:
- subscribedUsers
- isSubscribed (ADDED)
- unsubscribe (ADDED)
- subscribeWithCompletion: (ADDED)
- setAttributes:completion: (REMOVED)
- setFriendlyName:completion: (REMOVED)
- Fix for absence of channel added delegate when a private channel is created from a separate endpoint.
- The iOS SDK now supports badging when enabled on your Chat instance for clients you have registered for push notifications. Badges will indicate the number of unread 1:1 channels the user has.
- Resolved an issue where the client creation call and updateToken calls may perform a network operation on the calling thread, blocking it. These operations now occur in the background and the calls once again return immediately.
- Introduced callback for badge updates on iOS. This delegate method will be called as a result of the chat library processing a notification via TwilioChatClient’s
handleNotification: method where the badge count updates. When your application is foregrounded, iOS will not automatically update the springboard badge count on its own so your application must manually update it. If your application receives its badge updates through a mechanism other than Twilio, you can omit this delegate method and handle this event in another way. See chatClient:notificationUpdatedBadgeCount: in the SDK docs or [demo application] for more information including a sample implementation.
- 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 forwardendpoint_id will be ignored if specified with your access token- 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]
- If a client is initially created with an invalid access token, creation will fail and nil will be returned for the client instance
- Resolved an issue where APNS registrations for the user may be lost after
shutdown of the client. Ensure when you are logging a user fully out of an application that registers for push notifications you call deregisterWithToken: with the device's token prior to shutdown to prevent messages continuing to be delivered to the device.
- Resolved an issue where crashes could occur during client shutdown, in particular while in the background
- Security enhancements
- Resolved issue where invalid tokens could cause a crash when foregrounding the application after being in the background.
- Resolved potential incompatibility with other Twilio SDKs in the same project
- Fix for channel added events not occurring with synchronization strategy .ChannelList
- Resolved issue with Framework short version string
- TwilioIPMessagingClient -> TwilioChatClient
- All TWM class prefixes to TCH
- AccessManager is removed from the SDK and provided as a stand-alone helper library
- Channels are now split between Public and User channels list.
- Unjoined public channels no longer fire channel added/removed/changed events
- Migration to asynchronous-only access to most entities within system
- Includes addition of paging to User and Public channels list as well as channel Members
- createdBy property
- memberWithIdentity method
- getUnconsumedMessagesCountWithCompletion:
- getMessagesCountWithCompletion:
- getMembersCountWithCompletion:
- allObjects
- userChannelsWithCompletion:
- publicChannelsWithCompletion:
- channelWithId:
- channelWithUniqueName:
- channelWithSidOrUniqueName:completion:
TCHChannelDescriptorPaginatorCompletion (ADDED)
TCHChannelPaginatorCompletion (ADDED)
TCHMemberPaginatorCompletion (ADDED)
TCHChannelCompletion (ADDED)
TCHChannelDescriptor (ADDED)
TCHChannelDescriptorPaginator
TCHChannelPaginator (ADDED)
TCHMemberPaginator (ADDED)
- allObjects
- membersWithCompletion:
- allObjects
- getMessageWithIndex:
- getMessageWithIndex:completion:
- messageForConsumptionIndex:
- messageForConsumptionIndex:completion:
If you are looking for the archived IP Messaging iOS changelog, it can be found here.