Links

iOS

This page contains an overview of all relevant changes made to the iOS SDK and the latest version releases

Version 6.18.0 (2023-09-22)

Features

  • Introduced an additional parameter in message query, called aroundMessageId, to support navigating to a specific message. For more information, please visit Navigating(Jump) to a specific message.
  • Fixed an issue where isDeleted property of message is not updated when message gets deleted.
  • Fixed a crash issue caused by QueryStreamReactor.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.42.3
  • Realm Swift Version: 10.42.3
  • Minimum Target: iOS 13.0

Version 6.17.0 (2023-09-08)

Features

  • Introduced target: AmityCommentTarget property in AmityComment for retrieving targetId and targetType related to the comment. If targetType is community type, the SDK will also provide creatorMember which is AmityCommunityMember.
  • Supported community users in comments for moderator role checking.
  • Added SwiftUI support for AmityCollection and AmityObject., for more information please visit SwiftUI Support page.
  • Fixed the issue where MQTT events were not received in the SDK.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.41.1
  • Realm Swift Version: 10.41.1
  • Minimum Target: iOS 13.0

Version 6.16.1 (2023-09-04)

Fixes

  • Fixed an issue where the message list jumps when adding reactions.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.42.0
  • Realm Swift Version: 10.42.0
  • Minimum Target: iOS 13.0

Version 6.16.0 (2023-08-25)

Features

  • Added a new API to retrieve a comment using its ID.

Fixes

  • Fixed an issue where the SDK would not update pendingCount correctly after the user accepted or declined a follow action.
  • Fixed an issue with sub-channel sorting not updating after receiving a messa

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.42.0
  • Realm Swift Version: 10.42.0
  • Minimum Target: iOS 13.0

Version 6.15.2 (2023-08-23)

Fixes

  • Fixed an issue where the SDK incorrectly returned the follow relationship status in the followInfo call, especially when querying for multiple follow relationships.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.42.0
  • Realm Swift Version: 10.42.0
  • Minimum Target: iOS 13.0

Version 6.15.1 (2023-08-16)

Fixes

  • Fixed the issue where the order of image messages was incorrect in certain cases.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.42.0
  • Realm Swift Version: 10.42.0
  • Minimum Target: iOS 13.0

Version 6.15.0 (2023-08-10)

Features

  • Limited PostRepository.getPosts() to exclude all deleted posts (both soft and hard deletes) not owned by the logged-in user, aligning with thisbehavioral-change-announcement.

Fixes

  • Fixed the issue where the myReactions property is not updated correctly when a message is received.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.42.0
  • Realm Swift Version: 10.42.0
  • Minimum Target: iOS 13.0

Version 6.14.0 (2023-08-04)

Features

  • Introduced the new Presence State feature in our SDK, allowing real-time synchronization of user statuses. Experience enhanced connectivity with online/offline indicators and seamless management of user presence within channels and users.
  • Supports unread mention status in user, channel, and subchannel levels. For further information, please refer to Unread Count page.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.41.1
  • Realm Swift Version: 10.41.1
  • Minimum Target: iOS 13.0

Version 5.33.8 (2023-08-04)

Fixes

  • Updated Realm version to 10.42.0 and fixed a random Realm crashes.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.42.0
  • Realm Swift Version: 10.42.0
  • Minimum Target: iOS 13.0

Version 6.13.1 (2023-08-02)

Fixes

  • Fixed the issue where the number of following/followers does not update.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.41.1
  • Realm Swift Version: 10.41.1
  • Minimum Target: iOS 13.0

Version 6.7.0 (2023-07-27)

Fixes

  • Resolved an issue that occasionally caused duplicate message displays within the message list.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.41.1
  • Realm Swift Version: 10.41.1
  • Minimum Target: iOS 13.0

Version 6.6.0-beta06 (2023-07-17)

Fixes

  • Fixed the issue of unread counts not reflecting correctly after a topic is hard deleted.
  • Fixed the issue of unread counts not being synchronized correctly after a user is removed or banned.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.12.0 (2023-07-14)

New Features

  • Introduced AmityFileRepository where users can now delete uploaded files by using deleteFile API. For further information, please visit Delete Files
  • Added getFile API to retrieve the AmityRawFile. AmityRawFile provides transform functions to map it into the correct file data type. For further information, please visit Retrieve Files

Fixes

  • Fixed the issue where the SDK does not show all tagged message lists when querying with a tag.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.11.1 (2023-07-10)

Fixes

  • Resolved the issue of incorrectness in the user's search result.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.6.0-beta05 (2023-07-04)

Fixes

  • Fixed the issue where the unread count does not sync when two devices, both using the same account, are opened simultaneously.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.6.0-beta04 (2023-06-29)

Fixes

  • This update fixes returning missing messages when specified includingTags as one of the query options.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.11.0 (2023-06-29)

Fixes

  • Fixed an issue where searching for users with keywords would return incorrect results.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 5.33.7 (2023-06-22)

Fixes

  • This update fixes returning wrong result when searching user with keyword.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 6.6.0-beta3 (2023-06-21)

New Features

  • Introduce a new feature which now supports unread count on multiple devices. When the user logs in to two devices with the same account and uses the chat feature simultaneously, the user should see the correct update of the unread count.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.10.0 (2023-06-16)

Features

  • Support Library Evolution in AmitySDK and UIKit, ensuring forward compatibility with future Xcode versions 🎉.
  • Resolved an issue with the sort order for user lists and community categories.
  • Fixed a crash that occurred when searching for channel members with roles.

Compatibility

  • Xcode Version: 14.3.1
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.9.0 (2023-06-01)

Deprecations

Compatibility

  • Xcode Version: 14.3
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 5.33.6 (2023-05-25)

Fixes

  • This update fixes crash issue on linked libraries.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 5.33.5 (2023-05-19)

Fixes

  • Fix issue when clicking "unlike" on a post with multiple likes, the number of likes should decrease by only 1 instead of resetting to 0.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 6.8.0 (2023-05-18)

New features

  • Introduce new creator object which returns AmityUser in AmityReaction model.

Deprecations

Compatibility:

  • Xcode Version: 14.3
  • Realm Version: 10.39.1
  • Realm Swift Version: 10.39.1
  • Minimum Target: iOS 13.0

Version 6.7.0 (2023-05-9)

New features

  • Add async APIs support on more functions, please check the newly supported functions in the deprecation note below.

Deprecations

Compatibility:

- Xcode Version: 14.1
- Realm Version: 10.32.2
- Realm Swift Version: 10.32.2
- Minimum Target: iOS 13.0

Version 6.6.0-beta02 (2023-05-5)

New features

  • Introduce message delivered count.
  • Introduce mark all messages in a channel as read
  • For further information please visit Unread Count.

Compatibility:

- Xcode Version: 14.1
- Realm Version: 10.32.2
- Realm Swift Version: 10.32.2
- Minimum Target: iOS 13.0

Version 6.6.0 (2023-04-20)

New features

  • Introduce blocking/unblocking user feature.
  • Introduce unread count in channels and subchannels.
  • Add async APIs in AmityFileRepository, AmityReactionRepository, AmityUserNotificationsManager and AmityChannelParticipation.

Deprecations:

Deprecated completion handler based APIs in these classes. Use async APIs instead.
AmityFileRepository
  • uploadImage, uploadFile, uploadVideo, downloadFile
AmityReactionRepository
  • addReaction, removeReaction
AmityUserNotificatonsManager
  • enable, disable
AmityChannelParticipation
  • addMembers, removeMembers

Compatibility:

- Xcode Version: 14.1
- Realm Version: 10.32.2
- Realm Swift Version: 10.32.2
- Minimum Target: iOS 13.0

Version 6.5.0 (2023-03-28)

Fixes:

  • Fix channel user role does not persist properly.
  • Fix sometimes crash on initialize AmityClient
  • Fix issue where message `isEdited` property would be true even when message was not edited.
  • Fix crash while watching live stream videos.

Deprecations

Compatibility:

- Xcode Version: 14.1
- Realm Version: 10.32.2
- Realm Swift Version: 10.32.2
- Minimum Target: iOS 13.0

Version 5.33.3 (2023-05-22)

Fixes

  • Fixed an issue that was causing random crashes during the initialization of the AmityClient.
  • Fixed an issue that was causing random crashes while watching live stream videos.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 6.2.2 (2023-03-16)

Improvement

  • The error messages have been improved to provide more clarity in certain cases. In particular, the error 800000 unknown has been dealt with in more detail.

Version 6.2.1 (2023-03-14)

Improvement

  • Improved the error messages for more clarity in certain cases.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3

Version 6.4.0 (2023-03-13)

New Features

Fixes:

  • Fixed issue where the SDK crashes on initializing AmityChannelRepository.

Compatibility:

  • Xcode Version: 14.1
  • Realm Version: 10.32.2
  • Realm Swift Version: 10.32.2
  • Minimum Target: iOS 13.0

Version 5.33.2 (2023-03-07)

Fixes

  • Fixed issue where the SDK crashes for some users with the error message "Cannot register notification blocks from within write transactions".

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 6.3.0 (2023-02-24)

New Features

  • AmityUser Live Collection now supports the automatic addition of new objects via real-time events. Affected APIs:
AmityUserRepository
func searchUser(_ displayName: String, sortBy: AmityUserSortOption) -> AmityCollection<AmityUser>
func getUsers(_ sortBy: AmityUserSortOption) -> AmityCollection<AmityUser>

Fixes

  • Fixed issue where the SDK crashes for some users with the error message "Cannot register notification blocks from within write transactions".

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 5.33.1 (2023-02-17)

Fixes

  • Fixed issue where the SDK crashes for some users with the error message "Cannot register notification blocks from within write transactions".

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 6.2.0 (2023-02-09)

Fixes

  • Fixed issue where local cache was cleared on query channels with 'firstPage'.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.32.2
  • Realm Swift Version: 10.32.2
  • Minimum Target: iOS 13.0

Version 6.1.0 (2023-02-03)

New Features

  • AmityCommunityMember Live Collection now supports the automatic addition of new objects via real-time events. Affected APIs:
AmityCommunityRepository
func searchMembers(...) -> AmityCollection<AmityCommunityMember>
  • Added new API for searching community members with keywords.
AmityCommunityRepository
func searchMembers(communityId: String, keyword: String, membership membershipOptions: AmityCommunityMembershipFilterOption, roles: [String], sortBy: AmityCommunityMembershipSortOption) -> AmityCollection<AmityCommunityMember>
  • AmityCommunity Live Collection now supports automatic addition of new items via real-time events. Affected APIs:
AmityCommunityRepository
func getCommunities(...) -> AmityCollection<AmityCommunity>
  • Added async/await API for deleteMessage, createCustomMessage, createTextMessage, createImageMessage, createAudioMessage, createFileMessage and createVideoMessage in AmityMesageRepository.
  • Introduced the ability to delete on a specific poll post.
AmityPollRepository
func deletePoll(...)

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 6.0.0 (2023-01-13)

New Features

  • Introduced Sub Channel functionality. Now users can create sub channels inside a channel.

Deprecations

  • All deprecated interfaces from AmitySDK v5.x.x has been removed in AmitySDK v6.0.0.

Breaking Changes

  • AmitySDK v6.0.0 has been written in PureSwift. This version has breaking changes in api interfaces. Please refer to the migration guide for more details.
  • Events related to channels of type Community & Conversation are automatically subscribed. To receive events for other type of channels, user needs to subscribe to it explicitly.
  • For subscribing to channel topics, create an instance of the AmityChannelTopic class and use the AmityTopicSubscription class to subscribe to it.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.32.2
  • Realm Swift Version: 10.32.2
  • Minimum Target: iOS 13.0

Version 5.33.0 (2022-12-16)

New Features

AmityClient {
public func login(userId: String, displayName: String?, authToken: String?, sessionHandler: SessionHandler) async throws
}
  • Added sesionState API to AmityClient
  • Added issuedAt, expiresAt API to AmityUserToken

Fixes

  • Fixed issue where the user could not send a reply to image messages
  • Fixed issue where the user could not see the existing message when editing it

Deprecations

  • Deprecated connectionState API
  • Deprecated old login API
AmityClient {
@available(*, deprecated)
@objc public func login(userId: String, displayName: String?, authToken: String?, completion: AmityRequestCompletion?)
}

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 5.32.0 (2022-12-02)

Fixes

  • SDK Upgrade

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 5.31.0 (2022-11-18)

New Features

  • Upgraded the post settings feature. When a moderator role is demoted to a user role, post creation must be approved by a moderator.
  • Introduced the ability to get video thumbnail image data from video messages using the AmityMessage.getVideoThumbnailImageInfo() function.

Fixes

  • Fixed issue where the application crashes when a globally banned user sends a message in a channel.

Compatibility

  • Xcode Version: 14.1
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 5.30.0 (2022-11-04)

New Features

  • Introduced the ability for User roles to create community with “Admin can post only” settings.

Fixes

  • Fixed issue where the global feed is not updated after creating a post in the community feed or user feed.

Compatibility

  • Xcode Version: 14.0
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 5.29.0 (2022-10-21)

New Features

  • Introduced the ability to query poll type.
  • Introduced a new moderatorCount property in AmityChannel to show the total number of moderator in the channel.
  • Introduced the ability to query message by type.

Fixes

  • Fixed issue where channels with a certain ID were not retrieved correctly.

Compatibility

  • Xcode Version: 14.0.0
  • Realm Version: 10.28.3
  • Minimum Target: iOS 13.0

Version 5.28.1 (2022-10-18)

Fixes

  • Fixed issue where the application crashes with errorCannot register notification blocks from within write transactions when fetching Live Object or Live Collection within observe block.

Compatibility

  • Xcode Version: 13.4.0
  • Realm Version: 10.28.3
  • Minimum Target: iOS 12.0

Version 5.28.0 (2022-10-07)

New Features

  • Introduced the ability to create video messgaes in Live, Broadcast, Community and Chat channels.
  • When creating a poll post, the setTimeToClosePoll value is set to 30 days by default if the user does not set any value.

Fixes