Methods

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.

AmityCoreClient, AmityChatClient, AmitySocialClient and, AmityVideoClient (EkoClient)

EkoSDK 4.0	Amity SDK 5.0
init(...)	AmityCoreClient.init(...)
setup(...)	AmityCoreClient.setup(...)
registerDeviceForPushNotification()	AmityCoreClient.registerDeviceForPushNotification()
unregisterDeviceForPushNotification(...)	AmityCoreClient.unregisterDeviceForPushNotification(...)
registerDevice(...)	AmityCoreClient.registerDevice(...)
unregisterDevice()	AmityCoreClient.unregisterDevice()
getUserId()	AmityCoreClient.getUserId()
getDisplayName()	Obsoleted use AmityCoreClient.getCurrentUser() instead
getUserMetadata()	Obsoleted use AmityCoreClient.getCurrentUser() insead
updateUser()	AmityCoreClient.updateUser()
hasPermission(...)	AmityCoreClient.hasPermission(...)
setDisplayName(...)	Obsoleted use AmityCoreClient.updateUser().displayName() instead
setUserMetadata(...)	Obsoleted use AmityCoreClient.updateUser().metadata() instead
getCurrentUser()	AmityCoreClient.getCurrentUser()
errors()	AmityCoreClient.errors()
notification()	AmityCoreClient.notification()
newUserRepository()	AmityCoreClient.newUserRepository()
newChannelRepository()	AmityChatClient.newChannelRepository()
newCommunityRepository()	AmitySocialClient.newCommunityRepository()
newFeedRepository()	AmitySocialClient.newFeedRepository()
newCommentRepository()	AmitySocialClient.newCommentRepository()
newStreamRepository()	AmityVideoClient.newStreamRepository()
getConfiguration()	AmityCoreClient.getConfiguration()

• EkoClient is separated to AmityCoreClient, AmityChatClient, AmitySocialClient and AmityVideoClient.

• Now you can use updateUser(...) method present in AmityCoreClient to set display name, avatar, avatar custom url, user metadata, user description.

AmityChannel (EkoChannel)

EkoSDK 4.0	AmitySDK 5.0
moderate()	moderation()

AmtiyChannelRepository (EkoChannelRepository)

EkoSDK 4.0	Amity SDK 5.0
getChannelCollection()	getChannels()
moderate()	moderation()

AmityChannelParticipation (EkoChannelParticipation)

EkoSDK 4.0	AmitySDK 5.0
getCollection()	getMembers()
addUsers(...)	addMembers(...)
removeUsers(...)	removeMembers(...)

AmityChannelNotification (EkoChannelNotification)

EkoSDK 4.0	AmitySDK 5.0
setAllowed(allowed: Boolean)	Obsoleted
isAllowed()	Obsoleted
-	enable()
-	disable()
-	getSettings()

• setAllowed(...) method has been removed and enable() and disable() method has been introduced.

• isAllowed() method is removed and getSettings method has been introduced

AmityChannelNotificationSettings (New class)

EkoSDK 4.0	AmitySDK 5.0
-	isEnabled()

AmityChannelModeration (EkoChannelModeration)

EkoSDK 4.0	AmitySDK 5.0
muteUsers(...)	muteMembers(...)
unmuteUsers(...)	unmuteMembers(...)
removeRateLimit()	Obsoleted
banUsers(...)	banMembers(...)
unbanUsers(...)	unbanMembers(...)

• Methods related to rateLimit has been removed.

AmtiyCommentRepository (EkoCommentRepository)

EkoSDK 4.0	Amity SDK 5.0
getReactionCollection(...)	getReactions(...)
getCommentCollection()	getComments()

AmtiyMessageRepository (EkoMessageRepository)

EkoSDK 4.0	Amity SDK 5.0
getMessageCollection(...)	getMessages(...)
getLatestMessage()	Obsoleted
getReactionCollection(...)	getReactions(...)

AmityCommunityRepository (EkoCommunityRepository)

EkoSDK 4.0	Amity SDK 5.0
createCommunityByAdmin(...)	createCommunity(...)
updateCommunityByAdmin(...)	updateCommunity(...)
getCommunityCollection()	getCommunities()
getAllCategories()	getCategories()
moderate()	moderation()

AmityCommunityParticipation (EkoCommunityParticipation)

EkoSDK 4.0	Amity SDK 5.0
addUsers(...)	addMembers(...)
removeUsers(...)	removeMembers(...)
getMemberships()	getMembers()

AmityFeedRepository (EkoFeedRepository)

EkoSDK 4.0	Amity SDK 5.0
getReactionCollection()	getReactions()
getCommentCollection()	getComments()

• getAllReactions has been merged with getReactions method

AmityAudioUploadService (EkoAudioUploader), AmityFileUploadService (EkoFileUploader)

EkoSDK 4.0	Amity SDK 5.0
notificationConfig(...)	Obsoleted

AmityImageUploadService (EkoImageUploader)

EkoSDK 4.0	Amity SDK 5.0
notificationConfig(...)	Obsoleted

AmityUploadInfo (EkoUploadInfo)

EkoSDK 4.0	Amity SDK 5.0
getStartTime(...)	Obsoleted
getElapsedTime(...)	Obsoleted
getTotalBytes(...)	getContentLength(...)
getUploadedBytes(...)	getBytesWritten(...)
getTotalFiles(...)	Obsoleted
getFilesLeft(...)	Obsoleted
getUploadRate(...)	Obsoleted

AmityUserRepository (EkoUserRepository)

EkoSDK 4.0	Amity SDK 5.0
getAllUsers()	getUsers()

AmityStreamRepository (EkoStreamRepository)

EkoSDK 4.0	Amity SDK 5.0
getStreamById(...)	getStream(...)
getStreamCollection(...)	getStreams(...)