-
Notifications
You must be signed in to change notification settings - Fork 493
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
Disambiguate twin classes from hub and dps service clients #2910
Merged
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
patilsnr
approved these changes
Oct 24, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Optimistic sign off
tmahmood-microsoft
approved these changes
Oct 24, 2022
timtay-microsoft
approved these changes
Oct 24, 2022
abhipsaMisra
approved these changes
Oct 24, 2022
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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.
Especially for customers that use our SDK clients together in the same file, we prefer to avoid naming conflicts that they otherwise have to disambiguate by using the full namespace (or aliasing types).
For this reason, I've renamed most twin types in hub service client to be
ClientTwin*
and in dps service client to beProvisioningTwin*
.I also took a look at the other type names and resolved some wrongness (like DeviceStatus when it also applies to modules, so renamed to ClientStatus).
The other change was TwinCollection and TwinProperties. I spent more time on this than anything. The user doesn't really interact with the TwinCollection type except off of the Twin class. It contains the Desired and Reported properties. So, I renamed that to ClientTwinDocument, which isn't a great name but not one the user should ever use directly. That freed up the TwinProperties name for what was TwinCollection, so it is now ClientTwinProperties. The other related types followed suit, so ClientTwinPropertyValue and ClientTwinPropertyArray.
Finally, the hub device client has some small number of classes for twin. I renamed it from ClientTwin to just Twin.
Thoughts?