Deprecate API interface, add user mention support #155
Conversation
This file contains 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
Summary: - deprecate the current `API` interface - expose `TeamsClient` to take its place - create common interfaces and helper code to abstract any specific Microsoft Teams message format - create new `botapi` package (limited functionality) - extend existing `MessageCard` type (where needed) type to support new behavior - port existing `goteamsnotify.MessageCard` types/functions/methods to a new `messagecard` package and deprecate existing `MessageCard` functionality provided by the `goteamsnotify` "base" package - update examples to reflect changes - restore support for overriding default `http.Client` - restore default project-specific user agent, support for overriding the default from client code While making these changes I've refactored code and attempted to clearly communicate which existing code/functionality is being deprecated, all without introducing breaking changes for client code. The `botapi` package added in this collection of changes is a minimal implementation. This package is intended to provide limited user mention functionality for channel updates as a "bridge" until future `Adaptive Card` support can be implemented. A future implementation of `Adaptive Card` support would provide a more complete experience, presumably providing a superset of the limited support in the `botapi` package and existing `MessageCard` functionality. refs GH-127 refs GH-134 refs GH-135 refs GH-154
atc0005
added
documentation
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.
Summary
APIinterfaceTeamsClientto take its placeMicrosoft Teams message format
botapipackage (limited functionality)MessageCardtype (where needed) type to supportnew behavior
goteamsnotify.MessageCardtypes/functions/methods toa new
messagecardpackage and deprecate existingMessageCardfunctionality provided by the
goteamsnotify"base" packagehttp.Clientoverriding the default from client code
Backwards compatibility
While making these changes I've refactored code and attempted to
clearly communicate which existing code/functionality is being
deprecated, all without introducing breaking changes for client code.
Limitations
The
botapipackage added in this collection of changes is a minimalimplementation. This package is intended to provide limited user
mention functionality for channel updates as a "bridge" until future
Adaptive Cardsupport can be implemented.Future
A future implementation of
Adaptive Cardsupport would provide amore complete experience, presumably providing a superset of the
limited support in the
botapipackage and existingMessageCardfunctionality.
References
http.Client#135