Rocket.Chat.Apps-engine
Rocket.Chat.Apps-engine copied to clipboard
[BREAK] API updates
What? :boat:
Remove deprecated methods and behaviors for version 2.0
Methods that will be removed:
-
App.getAppUsername()- Developers should useIRead.getUserReader().getAppUser()instead -
ILivechatRead.getLivechatVisitors(query)- There are alternative methods available in theILivechatReadinterface that allow specific querying of visitors -
IRoomBuilder.addUsername(username)- Replace withaddMemberToBeAddedByUsernamemethod of the same interface -
IRoomBuilder.setUsernames(usernames)- Replace withsetMembersByUsernamesmethod of the same interface -
IRoomBuilder.getUsernames()- Replace withgetMembersUsernamesof the same interface -
ILivechatRead.isOnlineAsync()- Replace withisOnline, which will change to be an async method
Events that will be removed:
-
ILivechatRoomClosedHandler- Developers should useIPostLivechatRoomClosedinstead
Methods that will suffer breaking changes:
-
ILivechatRead.isOnline(departmentId?)- Return type will change frombooleantoPromise<boolean> -
IUserRead.getAppUser(appId?)- The parameterappIdwill be removed
Data types that will suffer breaking changes:
-
IRoom- propertyusernameswill be removed; To get the members of a room (users inside a room), use theIRoomRead.getMembers()method.
Links :earth_americas:
Need to update dependency on this PR later https://github.com/RocketChat/Rocket.Chat/pull/27696