feat: implement constructor for BridgeApi with key and name parameters#1395
Merged
Conversation
ediablo80
approved these changes
Mar 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support for specifying a device name when constructing bridge API implementations, aligning bridge instances with the broader Device/EssentialsDevice key+name model.
Changes:
- Added a new protected
BridgeApi(string key, string name)constructor that forwards toEssentialsDevice(key, name). - Updated
EiscApiAdvancedto passdc.Namewhen constructing the baseBridgeApi.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+37
to
+38
| /// <param name="key"></param> | ||
| /// <param name="name"></param> |
There was a problem hiding this comment.
The XML doc comments for this new constructor have empty <param> descriptions. Please document what key and name represent (similar to the existing single-parameter constructor) so generated docs/intellisense are useful.
Suggested change
| /// <param name="key"></param> | |
| /// <param name="name"></param> | |
| /// <param name="key">Device key</param> | |
| /// <param name="name">Device name</param> |
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.
This pull request introduces a minor enhancement to the bridge API infrastructure by adding support for passing a
nameparameter to theBridgeApiconstructor. This allows for more descriptive instantiation of bridge APIs, particularly when creating advanced EISC API objects.Constructor enhancements:
BridgeApiclass that accepts bothkeyandnameparameters, enabling derived classes to specify a device name during instantiation.EiscApiAdvancedclass to use the newBridgeApiconstructor, passing bothdc.Keyanddc.Namefor improved clarity and consistency.