refactor!: adjust library api for easier extension - #41
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The following restructurings have been made that require migration:
1.
MatrixEventConsumerreceives an event object instead of multiple parametersPreviously, event listeners received multiple parameters with details about the event that happened.
This is a bit annoying for future extension however as changing parameters is a breaking change.
Instead, methods on the listener receive an event object specific to the event triggered that contains details.
This event object can be extended in the future without breaking API.
Previously:
Now:
2.
MatrixMessageno longer contains information about a message eventPreviously,
MatrixMessagecontained information about a sender and its event id.This however is information exclusively relevant and available for received messages.
This made it impossible to reuse these classes for sending messages.
Now
MatrixMessageonly holds information about the message itself, while information about an incoming message event is separated inMatrixMessageEvent.3. Adjusted packages for public API
Several parts of the public API have been moved into appropriate packages and have been converted to interfaces to better allow hidden implementation details.
MatrixState:MatrixRoom:MatrixUser:MatrixMessage:MatrixTextMessage:MatrixEmoteMessage:MatrixNoticeMessage: