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

Disambiguate twin classes from hub and dps service clients #2910

Merged
merged 4 commits into from
Oct 24, 2022

Conversation

drwill-ms
Copy link
Contributor

@drwill-ms drwill-ms commented Oct 24, 2022

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 be ProvisioningTwin*.

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?

Copy link
Contributor

@patilsnr patilsnr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optimistic sign off

@drwill-ms
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@drwill-ms drwill-ms merged commit 3ec4995 into previews/v2 Oct 24, 2022
@drwill-ms drwill-ms deleted the drwill/twin-types branch October 24, 2022 22:02
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.

5 participants