This repository was archived by the owner on Nov 5, 2025. It is now read-only.
Add documentation for register method#155
Closed
shiqimei wants to merge 15 commits intoRocketChat:masterfrom
Closed
Add documentation for register method#155shiqimei wants to merge 15 commits intoRocketChat:masterfrom
shiqimei wants to merge 15 commits intoRocketChat:masterfrom
Conversation
* Add interfaces IExternalComponent and IExternalComponentExtend * Add externalComponents property for IConfigurationExtend * export IExternalComponent * Add interface IExternalComponentLocationOptions * implement the interface IExternalComponentsExtend * export ExternalComponentsExtend * Add externalComponentManager for AppManager * implement AppExternalComponentManager * Implement IExternalComponentBridge * Add getExternalComponentBridge method for AppBridges * export AppExternalComponentManager * Update getConfigurationExtend method for AppAccessorManager * [TEST] Update appBridge and add externalComponentBridge * Update related test scripts * Remove IExternalComponentBridge interface * AppExternalComponentManager maintains the list of all registered components itself * Update test scripts * Add webhooks interface for the external component * Update the interface IExternalComponent * Add description field to the interface IExternalComponent
* update IWebHooks interface * Add util randomString * add AppEmbeddedSDK * move constants to src/client/constants directory * separate initListener from call method * rename initListener to init
This reverts commit 0b88a18.
* chore: change comment style to obtain VS Code Intellisense * feat: add unregisterComponent method We made follwing changes for the AppExternalComponentManager: * add new private property - appTouchedComponents * add new public method unregisterComponent * add new public method getExternalComponent * Add unregisterComponent in the lifecycle methods We need to call unregisterComponent method to remove the corresponding external components from the providedComponents when following AppManager's methods are called: * `unload` is called * `disable` is called <-> Disable an app * `remove` is called <-> Uninstall an app * `updateAppsMarketplaceInfo` is called and validateLicense not pass * `initializeApp` is called and validateLicense not pass * `enableApp` is called but is not success * Add new AppExternalComponentManager method purgeComponent when remove an app from the system, we need delete its external component from both providedComponents map set and appTouchedCompoents map set. * fix: new deployed app registers externalComponents automatically since the new deployed app will try to register their externalComponent when the `initializeApp` method of AppManager is called. This is not expected behavior. We introduce a new parameter `addToProvidedComponents` for the method `registerComponent` to handle the above problem. Without specifying `registerComponent` to true, the app only "declares" it touched the external component when it is initialized. Only if the `enableApp` method is called, the external component will truly added to providedComponents map set, which means we can access it in the `Game Center`.
* update IWebHooks interface * Add util randomString * add AppEmbeddedSDK * move constants to src/client/constants directory * separate initListener from call method * rename initListener to init * add appId to IExternalComponent interface
* Add interfaces IUserInfo and IRoomInfo * Add documentation for the public methods * getUserInfo * getRoomInfo * Rename AppEmbeddedSDK to AppClientEmbeddedSDK * rename to make sure others can see that it's for client-side * add the class documentation for the AppClientEmbeddedSDK * Rename the AppClientEmbeddedSDK methods * Rename to make sure others can see it's for client-side * Add documentation for the IClientRoomInfo and IClientInfo interfaces
* remove tests externalComponentBridge * remove the extra blank line * fix typos and add necessary blank lines * fix a grammar error in comments * Rename names to avoid confusions * rename IExternalComponentsExtend to IExternalComponentExtend * rename externalComponents to externalComponent
Codecov Report
@@ Coverage Diff @@
## master #155 +/- ##
=========================================
Coverage ? 57.67%
=========================================
Files ? 65
Lines ? 2266
Branches ? 350
=========================================
Hits ? 1307
Misses ? 959
Partials ? 0
Continue to review full report at Codecov.
|
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
resolved review: #145 (comment)