Migrate your Chat iOS SDK to Conversations

(information)

Info

If you are not using >=4.0.0 of our Chat SDK (or later), please follow the appropriate migration guides to get to v4+ before following this guide.

We are happy you decided to migrate your Programmable Chat iOS SDK to Conversations. It is a great decision and this guide will simplify the process a lot. The bulk of the work is primarily renaming, which will be covered here. You should also review this companion guide that covers the high-level changes and new APIs in Conversations.

Update your CocoaPods or Carthage dependency

CocoaPodsCarthage

1# Replace
2
3pod "TwilioChatClient"
4
5# with
6
7pod "TwilioConversationsClient"
8

Rename project imports

SwiftObjective-C

1import TwilioChatClient
2
3// becomes
4
5import TwilioConversationsClient
6

Rename entities

TCHTwilioChatClient becomes TCHTwilioConversationsClient
TCHChannel becomes TCHConversation
TCHMember becomes TCHParticipant
TCHClientSynchronizationStatusChannelsListCompleted becomes TCHClientSynchronizationStatusConversationsListCompleted

Refactor method calls

Intermediate accessor objects were removed so your code will look cleaner.

Client

SwiftObjective-C

1TwilioChatClient.chatClient(withToken:properties:delegate:completion:)
2
3// becomes
4
5TwilioConversationsClient.conversationsClient(withToken:properties:delegate:completion:)
6
7

Users

SwiftObjective-C

1TwilioChatClient.users.subscribedUser(withIdentity:completion:)
2
3// becomes
4
5TwilioConversationsClient.subscribedUser(withIdentity:completion:)
6

Channel

SwiftObjective-C

1Channel.member(withIdentity:)
2
3// becomes
4
5Conversation.participant(withIdentity:)
6

Channels

SwiftObjective-C

1TwilioChatClient.channels.subscribedChannels()
2// becomes
3TwilioConversationsClient.myConversations()
4
5//-------------------------------------------------------------
6
7TwilioChatClient.channels.createChannel(options:completion:)
8// becomes
9TwilioConversationsClient.createConversation(options:completion:)
10
11//-------------------------------------------------------------
12
13TwilioChatClient.channels.channel(withSidOrUniqueName:completion:)
14// becomes
15TwilioConversationsClient.conversation(withSidOrUniqueName:completion:)
16

Members

SwiftObjective-C

1Channel.members.members(completion:)
2// becomes
3Conversation.participants()
4
5//-------------------------------------------------------------
6
7Channel.members.add(byIdentity:completion:)
8// becomes
9Conversation.addParticipant(byIdentity:attributes:completion:)
10
11//-------------------------------------------------------------
12
13Channel.members.remove(_:completion:)
14// becomes
15Conversation.removeParticipant(_:completion:)
16

Messages

SwiftObjective-C

1Channel.messages. sendMessage(with:completion:)
2// becomes
3Conversation.sendMessage(with:completion:)
4
5//-------------------------------------------------------------
6
7Channel.messages.removeMessage(_:completion:)
8// becomes
9Conversation.removeMessage(_:completion:)
10
11//-------------------------------------------------------------
12
13Channel.messages.getLastMessages(withCount:completion:)
14// becomes
15Conversation.getLastMessages(withCount:completion:)
16
17//-------------------------------------------------------------
18
19Channel.messages.getMessagesBefore(_:withCount:completion:)
20// becomes
21Conversation.getMessagesBefore(_:withCount:completion:)
22
23//-------------------------------------------------------------
24
25Channel.messages.getMessagesAfter(_:withCount:completion:)
26// becomes
27Conversation.getMessagesAfter(_:withCount:completion:)
28
29//-------------------------------------------------------------
30
31Channel.messages.message(withIndex:completion:)
32// becomes
33Conversation.message(withIndex:completion:)
34
35//-------------------------------------------------------------
36
37Channel.messages.message(forConsumptionIndex:completion:)
38// becomes
39Conversation.message(forReadIndex:completion:)
40
41//-------------------------------------------------------------
42
43Channel.messages.lastConsumedMessageIndex
44// becomes
45Channel.lastReadMessageIndex
46
47//-------------------------------------------------------------
48
49Channel.messages.setLastConsumedMessageIndex(_:completion:)
50// becomes
51Conversation.setLastReadMessageIndex(_:completion:)
52
53//-------------------------------------------------------------
54
55Channel.messages.advanceLastConsumedMessageIndex(_:completion:)
56// becomes
57Conversation.advanceLastReadMessageIndex(_:completion:)
58
59//-------------------------------------------------------------
60
61Channel.messages.setAllMessagesConsumedWithCompletion(_:)
62// becomes
63Conversation.setAllMessagesReadWithCompletion(_:)
64
65//-------------------------------------------------------------
66
67Channel.messages.setNoMessagesConsumedWithCompletion(_:)
68// becomes
69Conversation.setAllMessagesUnreadWithCompletion(_:)

1[Channel.messages sendMessageWithOptions:completion:]
2// becomes
3[Conversation sendMessageWithOptions:completion:]
4
5//-------------------------------------------------------------
6
7[Channel.messages removeMessage:completion:]
8// becomes
9[Conversation removeMessage:completion:]
10
11//-------------------------------------------------------------
12
13[Channel.messages getLastMessagesWithCount:completion:]
14// becomes
15[Conversation getLastMessagesWithCount:completion:]
16
17//-------------------------------------------------------------
18
19[Channel.messages getMessagesBefore:withCount:completion:]
20// becomes
21[Conversation getMessagesBefore:withCount:completion:]
22
23//-------------------------------------------------------------
24
25[Channel.messages getMessagesAfter:withCount:completion:]
26// becomes
27[Conversation getMessagesAfter:withCount:completion:]
28
29//-------------------------------------------------------------
30
31[Channel.messages messageWithIndex:completion:]
32// becomes
33[Conversation messageWithIndex:completion:]
34
35//-------------------------------------------------------------
36
37[Channel.messages messageForConsumptionIndex:completion]
38// becomes
39[Conversation messageForReadIndex:completion:]
40
41//-------------------------------------------------------------
42
43Channel.messages.lastConsumedMessageIndex
44// becomes
45Conversation.lastReadMessageIndex
46
47//-------------------------------------------------------------
48
49[Channel.messages setLastConsumedMessageIndex:completion:]
50// becomes
51[Conversation setLastReadMessageIndex:completion:]
52
53//-------------------------------------------------------------
54
55[Channel.messages advanceLastConsumedMessageIndex:completion:]
56// becomes
57[Conversation advanceLastReadMessageIndex:completion:]
58
59//-------------------------------------------------------------
60
61[Channel.messages setAllMessagesConsumedWithCompletion:]
62// becomes
63[Conversation setAllMessagesReadWithCompletion:]
64
65//-------------------------------------------------------------
66
67[Channel.messages setNoMessagesConsumedWithCompletion:]
68// becomes
69[Conversation setAllMessagesUnreadWithCompletion:]

Remove or replace unsupported methods

Channels subscribedChannelsSortedBy
Channels userChannelDescriptorsWithCompletion
Channels publicChannelDescriptorsWithCompletion
Members inviteByIdentity:completion:

New APIs

SwiftObjective-C

1// added
2Conversation.addParticipant(byAddress:proxyAddress:attributes:completion:)
3
4// added
5Conversation.removeParticipant(byIdentity:completion:)
6

Added aggregated delivery receipts

You can get delivery receipts for each SMS or WhatsApp message to understand the current status of delivery.

Added conversation state

Conversations now have state.

Added update reason TCHConversationUpdateState.
Current state of conversation you can get by calling Conversation.state()

Rename consumptionHorizon to readHorizon

Update reasons
- TCHChannelUpdateLastConsumedMessageIndex becomes TCHConversationUpdateLastReadMessageIndex
- TCHParticipantUpdateLastConsumedMessageIndex becomes TCHParticipantUpdateLastReadMessageIndex
- TCHParticipantUpdateLastConsumedTimestamp becomes TCHParticipantUpdateLastReadTimestamp
Channel.getUnconsumedMessagesCountWithCompletion becomes Conversation.getUnreadMessagesCountWithCompletion
Member.lastConsumedMessageIndex becomes Participant.lastReadMessageIndex
Member.lastConsumptionTimestamp becomes Participant.lastReadTimestamp
Member.lastConsumptionTimestampAsDate becomes Participant.lastReadTimestampAsDate

Media changes

There are no more streams used to download media. Instead, you'll retrieve a temporary data URL to download it.

SwiftObjective-C

1getMediaContentTemporaryUrl(completion:)
2

Other changes

Public conversations are unavailable for Conversations SDK, conversationWithSidOrUniqueName returns an error if the conversation is public.
TCHChannelType is removed.
Instead of removed subscribedChannelsSortedBy method, sort the list returned from myConversations.
TCHChannelDescriptor, TCHUserDescriptor were removed. Use TCHConversation and TCHUser objects instead.
Paginators were removed
Invites are not supported by Conversations SDK. Use addParticipantByIdentity and addParticipantByAddress instead.
TCHConversationStatus could be now either joined or notParticipating.