Some of the method signature has been changed to make it more consistent across SDK. This list contain those changes.
Please refer to each feature documentation for its sample code implementation.
AmityClient: (EkoClient)
Now you can use updateUser(builder: _)
method present in AmityClient
to set display name, avatar, avatar custom url, user metadata, user description.
AmityChannelRepository: (EkoChannelRepository)
Use createChannel
method to create channel of type Conversation. createConversation
method has been removed.
Use getChannels
method to fetch list of channels. channelsForFilter
has been removed.
Use leaveChannel
method to leave the channel. This method is now removed from AmityChannelParticipation
class.
Use updateChannel
method to set metadata, display name, tags, avatar etc.
AmityChannelParticipation (EkoChannelParticipation)
Leaving channel is now supported from AmityChannelRepository
class
memberships
property which returned live collection of members has been removed. Use getMembers
method to fetch list of members
AmityChannelNotificationsManager: (EkoChannelNotificationsManager)
setIsAllowed:
method has been removed and enable:
and disable:
method has been introduced.
isAllowed
method is removed and getSettings:
method has been introduced
AmityChannelModeration (EkoChannelModeration)
previleges
method has been removed. Use hasPermission
method present in EkoClient
instead
Methods related to rateLimit
has been removed.
EkoMediaRepository:
This class has been removed. Refer to AmityFileRepository
for downloading media.
AmityFileRepository: (EkoFileRepository)
Now uploadImage
and uploadFile
method accepts URL of the image/file from local file system.
Now download methods do not accept fileId. Use fileURL
which is available from AmityImageData
and AmityFileData
instead.
You can implement your own download operations and downlaod files from this fileURL directly.
Important: Any files downloaded from AmityFileRepository
are not cached. It is responsibility of the user themselves to implement caching mechanism.
AmityUserRepository (EkoUserRepository):
AmityUserFlagger (EkoUserFlagger):
AmityUserNotificationSettings (EkoUserNotificationSettings)
AmityMessageRepository: (EkoMessageRespository)
Methods to fetch list of messages has been simplified. You can get list of messages from getMessages
method.
Methods to create message has been simplified. Now there is single createTextMessage
method.
createImageMessage
accepts URL of the image from local file system. Previous method which accepts UIImage
has been removed.
createAudioMessage
& createFileMessage
accepts URL of the file from local file system. Previous method which accepted Data
has been removed.
downloadImage
& downloadFile
method has been removed. Use AmityFileRepository
to download instead.
setTags
method has been moved to AmityMessageEditor
class.
AmityMessageEditor: (EkoMessageEditor)
deleteMessage
method has been moved from AmityMessageEditor
to AmityMessageRepository
AmityMessageFlagger: (EkoMessageFlagger)
EkoMessageReactor & EkoMessageReaction
EkoMessageReactor
class has been removed. Use AmityReactionRepository
to add or remove reactions instead.
EkoMessageReaction
has been removed. Use AmityReaction
class instead.
AmityReactionRepository: (EkoReactionRepository)
getAllReactions
method is now merged to getReactions
method. Use it instead.
AmityCommentRepository: (EkoCommentRepository)
deleteComment
method is introduced in AmityCommentRepository
and removed from AmityCommentEditor
AmityCommentEditor: (EkoCommentEditor):
deleteComment
method has been moved to AmityCommentRepository
AmityCommentFlagger: (EkoCommentFlagger):
AmityCommunityRepository (EkoCommunityRepository
keyword
has been changed to displayName
for getCommunities
method.
AmityCommunityParticipation (EkoCommunityParticipation)
EkoCommunityMembership
has been changed to AmityCommunityMember
AmityCommunityModeration (EkoCommunityModeration)
AmityCommunityNotificationsManager (EkoCommunityNotification)
AmityFeedRepository (EkoFeedRepository)
getAllReactions
has been merged with getReactions
method
The names of the classes contain Amity
prefix instead of Eko
. Some classes are removed & renamed.
EkoChat
AmitySDK 5.0.0
unregisterDevicePushNotification
unregisterDeviceForPushNotification
setAvatar(image: UIImage)
Removed
setAvatarCustomUrl(avatarUrl: String)
Removed
setDisplayName(displayName: String?)
Removed
setUserMetadata(data: [String: Any]?)
Removed
setUserDescription(description: String)
Removed
EkoChat
AmitySDK 5.0.0
createConversation
Removed
channelsForFilter
Removed
setMetadata
Removed
setDisplayName
Removed
setTags
Removed
setAvatar
Removed
channelCollection
getChannels
-
leaveChannel (New)
EkoChat
AmitySDK 5.0.0
leaveChannel
removed
memberships
removed
membershipsForFilter
getMembers
addUsers
addMembers
removeUsers
removeMembers
EkoChat
AmitySDK 5.0.0
setIsAllowed
enable()
disable()
isAllowed
getSettings()
EkoChat
AmitySDK 5.0.0
privileges
Removed
rateLimit
Removed
removeRateLimit
Removed
muteUsers
muteMembers
unmuteUsers
unbanMembers
banUsers
banMembers
unbanUsers
unbanMembers
EkoChat
AmitySDK 5.0.0
-
uploadImage(withURL:_) (New)
-
uploadFile(withURL: _) (New)
downloadImage(fileId: _)
downloadImageAsData(fromURL: _)
-
downloadImage(fromURL: _)
downloadFile(fileId: _)
downloadFileAsData(fromURL: )
Content
downloadFile(fromURL:)
EkoChat
AmitySDK 5.0.0
userForId
getUser
getAllUsers
getUsers
EkoChat
AmitySDK 5.0.0
isFlagByMe
isFlaggedByMe
EkoChat
AmitySDK 5.0.0
Content
Content
isAllowed
getSettings
enableSetting
enable
disableSetting
disable
EkoChat
AmitySDK 5.0.0
-
deleteMessage (New)
allMessagesReactions
getReactions
messages
getMessages - (Removed overloaded methods)
createTextMessage
createTextMessage - (Removed overloaded methods)
createImageMessage
createImageMessage - (Removed overloaded methods)
createFileMessage
createFileMessage - (Removed overloaded methods)
createAudioMessage
createAudioMessage - (Removed overloaded methods)
setTags
Removed
downloadImage
Removed
downloadFile
Removed
EkoChat
AmitySDK 5.0.0
-
setTags (New)
delete
Removed
EkoChat
AmitySDK 5.0.0
isFlagByMe
isFlaggedByMe
EkoChat
AmitySDK 5.0.0
getAllReactions
Removed
EkoChat
AmitySDK 5.0.0
comments(: _)
getComments
-
deleteComment (New)
EkoChat
AmitySDK 5.0.0
delete
Removed
EkoChat
AmitySDK 5.0.0
isFlagByMe
isFlaggedByMe
EkoChat
AmitySDK 5.0.0
getCommunitiesWithKeyword
getCommunities
getAllCategories
getCategories
EkoChat
AmitySDK 5.0.0
addUsers
addMembers
removeUsers
removeMembers
getMemberships
getMembers
getMembership
getMember
EkoChat
AmitySDK 5.0.0
banUsers
banMembers
unbanUsers
unbanMembers
EkoChat
AmitySDK 5.0.0
enableSettings
enable
disableSettings
disable
getPushNotificationSettings
getSettings
EkoChat
AmitySDK 5.0.0
getAllReactions
getReactions
EkoChat | AmitySDK 5.0.0 |
EkoClient | AmityClient |
EkoClientErrorDelegate | AmityClientErrorDelegate |
EkoCollection | AmityCollection |
EkoObject | AmityObject |
EkoNotificationToken | AmityNotificationToken |
Content | Content |
Channel: | Content |
EkoChannelRepository | AmityChannelRepository |
EkoChannel | AmityChannel |
EkoChannelMembership | AmityChannelMember |
EkoChannelMembershipPrivileges | AmityChannelMembershipPrivileges |
EkoChannelModeration | AmityChannelModeration |
EkoChannelNotificationsManager | AmityChannelNotificationsManager |
EkoChannelParticipation | AmityChannelParticipation |
EkoConversationChannelBuilder | AmityConversationChannelBuilder |
EkoCommunityChannelBuilder | AmityCommunityChannelBuilder |
EkoLiveChannelBuilder | AmityLiveChannelBuilder |
EkoChannelBuilder | AmityChannelBuilder |
EkoChannelUpdateBuilder | AmityChannelUpdateBuilder |
Content | Content |
Message: | Content |
EkoMessage | AmityMessage |
EkoMessageEditor | AmityMessageEditor |
EkoMessageFlagger | AmityMessageFlagger |
EkoMessageRepository | AmityMessageRepository |
Content | Content |
User: | Content |
EkoUserFlagger | AmityUserFlagger |
EkoUser | AmityUser |
EkoUserRepository | AmityUserRepository |
EkoUserNotification | AmityUserNotificationSettings |
Content | Content |
Comment: | Content |
EkoCommentRepository | AmityCommentRepository |
EkoComment | AmityComment |
EkoCommentEditor | AmityCommentEditor |
EkoCommentFlagger | AmityCommentFlagger |
Content | Content |
Community: | Content |
EkoCommunityCreationDataBuilder | AmityCommunityCreationDataBuilder |
EkoCommunityUpdateDataBuilder | AmityCommunityUpdateDataBuilder |
EkoCommunity | AmityCommunity |
EkoCommunityRepository | AmityCommunityRepository |
EkoCommunityMembership | AmityCommunityMember |
EkoCommunityCategory | AmityCommunityCategory |
EkoCommunityModeration | AmityCommunityModeration |
EkoCommunityParticipation | AmityCommunityParticipation |
EkoCommunityNotification | AmityCommunityNotificationSettings |
Content | Content |
Feed: | Content |
EkoFeedRepository | AmityFeedRepository |
EkoPost | AmityPost |
EkoTextPostBuilder | AmityTextPostBuilder |
EkoImagePostBuilder | AmityImagePostBuilder |
EkoFilePostBuilder | AmityFilePostBuilder |
EkoPostFlagger | AmityPostFlagger |
Content | Content |
Reaction: | Content |
EkoReaction | AmityReaction |
EkoReactionRepository | AmityReactionRepository |
Content | Content |
File: | Content |
EkoFileRepository | AmityFileRepository |
EkoFileData | AmityFileData |
EkoImageData | AmityImageData |
Content | Content |
Stream: | Content |
EkoStreamRepository | AmityStreamRepository |
EkoStream | AmityStream |
EkoLiveStreamURLInfo | AmityLiveStreamURLInfo |
EkoStreamNotificationsManager | AmityStreamNotificationsManager |
EkoLiveVideoRecordingData | AmityLiveVideoRecordingData |
EkoStreamStatus | AmityStreamStatus |
EkoStreamCollectionQuery | AmityStreamCollectionQuery |
Content | Content |
Enums: | Content |
EkoChannelMembershipFilter | AmityChannelMembershipFilter |
EkoPermission | AmityPermission |
EkoCommunityType | AmityCommunityType |
EkoOrderBy | AmityOrderBy |
EkoSortBy | AmitySortBy |
EkoQueryOption | AmityQueryOption |
EkoPostTargetType | AmityPostTargetType |
EkoCommentReferenceType | AmityCommentReferenceType |
EkoCommunityCategoriesSortOption | AmityCommunityCategoriesSortOption |
EkoCommunityMembershipFilter | AmityCommunityMembershipFilter |
EkoCommunityMembershipSortOption | AmityCommunityMembershipSortOption |
EkoCommunitySortOption | AmityCommunitySortOption |
EkoCommunityQueryFilter | AmityCommunityQueryFilter |
EkoSyncState | AmitySyncState |
EkoCommunityFeedSortOption | AmityCommunityFeedSortOption |
EkoUserFeedSortOption | AmityUserFeedSortOption |
EkoUserSortOption | AmityUserSortOption |
EkoDataType | AmityDataType |
EkoReferenceType | AmityReferenceType |
EkoCommunityMembershipType | AmityCommunityMembershipType |
EkoChannelMembershipType | AmityChannelMembershipType |
EkoErrorCode | AmityErrorCode |
EkoDataStatus | AmityDataStatus |
EkoLoadingStatus | AmityLoadingStatus |
EkoChannelQueryFilter | AmityChannelQueryFilter |
EkoConnectionStatus | AmityConnectionStatus |
Content | Content |
Removed: | Content |
EkoMediaRepository | Removed |
EkoMessageReactor | Removed |
EkoMessageReaction | Removed |
Content | Content |
This guide is to provide information about breaking changes and how to migrate AmitySDK iOS 5.0.0 version.
AmitySDK 5.0.0 is the major release of our SDK. As a major release, following Semantic Versioning conventions, 5.0.0 introduces API-breaking changes. This guide covers all the breaking changes and has been created to ease the transition from older SDK version (i.e SDK below 5.0.0) to AmitySDK 5.0.0.
EkoChat
framework has been renamed to AmitySDK
. So import EkoChat
needs to be changed to import AmitySDK
.
All the public classes & interfaces which uses Eko
prefix has been changed to use Amity
prefix. For Example, EkoChannel
has been changed to AmityChannel
.