We recommend using these links in your projects. As we patch bugs, these links will automatically be updated with the fixes.
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 JavaScript.
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 JavaScript.
If you are looking for the archived IP Messaging JavaScript changelog, it can be found here.
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.
In this release we have revised all updated events. Each revised event now receives an object which contains:
channel, member, message, userattributes, friendlyName, body, etc.Additionally, the Channel.LastMessage structure is updated to contain only last message's creation timestamp and index (effectively removing author and sid)
Client#event:channelUpdatedChannel#event:updatedClient#event:memberUpdatedChannel#event:memberUpdatedMember#event:updatedClient#event:messageUpdatedChannel#event:messageUpdatedMessage#event:updatedClient#event:userUpdatedUser#event:updatedchannel.sendMessage() promise resolve type to Promise<number>logLevel is now set to silent, log lines now includes timestampsid and author properties from Channel.LastMessage typeClient.shutdown(), introducing new types for various methodstokenAboutToExpire, tokenExpired (essentially removing need for AccessManager use)index property to Channel.LastMessage typeClient.unsetPushRegistrationId to unregister from push notificationslastMessage structure to ChannelClient.getLocalChannels to get (sorted) locally known channels, sorting is possible by uniqueName, friendlyName, or lastMessageClientOptions between two clients creations in the same browser or node.js sessionMessage with type media the body property now is null (instead of placeholder about unsupported media messaging)Client#connectionStateChanged event: adding disconnected and disconnecting statesThis release is identical to 2.0.0. The sole purpose is to publish the new version to npmjs.com.
Removed deprecated Client constructor and Client.initialize function, the correct way now is to use static function Client.create.
Behavioral breaking change in adding Member and joining Channel, now if User is already in the Channel, then Channel.add and Channel.join will throw SessionError. Changed function signature in Consumption Horizon functions, after successful setting of last message consumed these functions returns unread messages count in given Channel for logged in User.
Channel.add and Channel.join functions will throw an SessionError in case of User already exists in the ChannelPromise<number> with count of unread messages in the channel after the operation:Channel.advanceLastConsumedMessageIndexChannel.updateLastConsumedMessageIndexChannel.setAllMessagesConsumedChannel.setNoMessagesConsumedClient constructorClient.initialize functionClient.version property now correctly displays Client's versionChannel.getUserDescriptors Channel.sendMessage method you can provide FormData (for browsers) or SendMediaOptions (browsers and node.js apps) to send media from your clientMessage class is extended with type attributeMessage class is extended with media attribute which holds Media class instancesendMediaMessage permission for users to be able to send Media MessagesPushNotification interface for push notification representationClient#event:pushNotification eventClient.parsePushNotification to handle push payload and return the PushNotification instance back to client (intended use is Firebase service worker)deprecated.messageRemoved events were not correctly firing for messages that present at client init (i.e. not added after client init)Client initialization has been simplified to reflect most users typical usage of the system. All user channels (channels for which the current user is joined to or an owner of) will be subscribed to from client startup but only the members roster will be synchronized initially. This keeps client startup fast while still reflecting the latest activity immediately to the client.
UserInfo has been deprecated and replaced with two distinct classed, User and UserDescriptor. Similar to ChannelDescriptor class, a UserDescriptor represents a snapshot of data in time that should be utilized directly after obtaining it but not retained since it will not be updated with new data over time.
Users are no longer implicitly subscribed to to improve performance on large instances. You can subscribe up to a maximum 100 of users at once after which your least recently subscribed User will be unsubscribed.
Client.getPublicChannels() function Client.getUserChannels() functionClient#event:userInfoUpdated eventMember.userInfo propertyMember#event:userInfoUpdated eventUserInfo classChannel.getUserDescriptors() functionChannelDescriptor.isPrivate propertyChannelDescriptor.lastConsumedMessageIndex propertyChannelDescriptor.status propertyChannelDescriptor.type propertyClient.getPublicChannelDescriptors() functionClient.getSubscribedChannels() functionClient.getSubscribedUsers() functionClient.getUser(identity) functionClient.getUserChannelDescriptors() functionClient.getUserDescriptor(identity) functionClient#event:userSubscribed eventClient#event:userUnsubscribed eventClient#event:userUpdated eventMember.getUser() functionMember.getUserDescriptor() functionUser classUserDescriptor classchannelAdded event for public channels being joined was correctly fired againendpoint_id identifier specified in access tokens is now automatically generated and persisted in the client browser cache. 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 tokendirection parameter to channel.getMessage method. backwardsis default direction to keep api compatible with previous versionsanchor parameter in channel.getMessage method was incorrectly processed.getChannelBySid and getChannelByUniqueName diretly after the client startclient.identity property. Use client.userInfo.identityWe all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.