Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BREAK] API updates #569

Draft
wants to merge 13 commits into
base: alpha
Choose a base branch
from
Draft

[BREAK] API updates #569

wants to merge 13 commits into from

Conversation

d-gubert
Copy link
Member

@d-gubert d-gubert commented Dec 29, 2022

What? ⛵

Remove deprecated methods and behaviors for version 2.0

Methods that will be removed:

  • App.getAppUsername() - Developers should use IRead.getUserReader().getAppUser() instead
  • ILivechatRead.getLivechatVisitors(query) - There are alternative methods available in the ILivechatRead interface that allow specific querying of visitors
  • IRoomBuilder.addUsername(username) - Replace with addMemberToBeAddedByUsername method of the same interface
  • IRoomBuilder.setUsernames(usernames) - Replace with setMembersByUsernames method of the same interface
  • IRoomBuilder.getUsernames() - Replace with getMembersUsernames of the same interface
  • ILivechatRead.isOnlineAsync() - Replace with isOnline, which will change to be an async method

Events that will be removed:

  • ILivechatRoomClosedHandler - Developers should use IPostLivechatRoomClosed instead

Methods that will suffer breaking changes:

  • ILivechatRead.isOnline(departmentId?) - Return type will change from boolean to Promise<boolean>
  • IUserRead.getAppUser(appId?) - The parameter appId will be removed

Data types that will suffer breaking changes:

  • IRoom - property usernames will be removed; To get the members of a room (users inside a room), use the IRoomRead.getMembers() method.

Links 🌎

Need to update dependency on this PR later RocketChat/Rocket.Chat#27696

PS 👀

@d-gubert d-gubert marked this pull request as ready for review January 5, 2023 18:17
@d-gubert d-gubert marked this pull request as draft January 6, 2023 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant