Emit event after capability re/negotiation#48
Merged
jryans merged 2 commits intomatrix-org:masterfrom Oct 28, 2021
Merged
Conversation
Contributor
Author
|
this example was used for testing: <!--
Copyright 2020 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Example Widget</title>
<!--
TESTING IN ELEMENT WEB
----------------------
To test this widget in Element Web, set up the widget library so it
can be resolved properly, then serve this directory off a web server.
An easy web server can be made with the http-server NPM package.
Once served, use the following command to add the widget to a room:
/addwidget http://localhost:8080/#/?widgetId=$matrix_widget_id&userId=$matrix_user_id
The widget should then load and present an interface for sticking the
widget to the screen (if approved for the capability). It is recommended
to have the JS console open to watch for errors and to see how the widget
works.
Note: this uses the fragment to pass parameters to avoid leaking widget
information to the web server. It is recommended to take a similar approach
with your own widgets.
-->
<!-- CSS is just for aesthetics and not important to the example -->
<link href="index.css" rel="stylesheet" />
</head>
<body>
<!-- The widget will be loaded into this container -->
<div id="container">Loading...</div>
<!-- Include the widget library -->
<script src="api.js"></script>
<!-- Bring in some utilities that aren't critical to the example -->
<script src="utils.js"></script>
<!-- The actual widget functionality -->
<script type="text/javascript">
try {
const qs = parseFragment();
const widgetId = assertParam(qs, 'widgetId');
const userId = assertParam(qs, 'userId');
let isSticky = false;
// Set up the widget API as soon as possible to avoid problems with the client
const widgetApi = new mxwidgets.WidgetApi(widgetId);
//uncomment to request on startup
//widgetApi.requestCapability(mxwidgets.MatrixCapabilities.RequiresClient);
widgetApi.on("ready", function() {
// Fill in the basic widget details now that we're allowed to operate.
document.getElementById("container").innerHTML = "Hello <span id='userId'></span>!<br /><br />"
+ "Currently stuck on screen: <span id='stickyState'></span><br /><br />"
+ "<button onclick='requestCaps()'>Toggle sticky state</button>";
// Fill in the user ID using innerText to avoid XSS
document.getElementById("userId").innerText = userId;
// Update the UI and ensure that we end up not sticky to start
// sendStickyState();
});
// Start the widget as soon as possible too, otherwise the client might time us out.
widgetApi.start();
function requestCaps() {
//request on button pressed
console.log("halle2")
widgetApi.requestCapability(mxwidgets.MatrixCapabilities.RequiresClient);
widgetApi.requestCapability(mxwidgets.MatrixCapabilities.AlwaysOnScreen);
widgetApi.updateRequestedCapabilities();
}
</script>
</body>
</html> |
jryans
suggested changes
Oct 27, 2021
Contributor
jryans
left a comment
There was a problem hiding this comment.
Seems sensible overall, just a few tweaks. 😄
786bd68 to
bb5d78c
Compare
jryans
approved these changes
Oct 28, 2021
Contributor
jryans
left a comment
There was a problem hiding this comment.
Thanks, this side looks good to me! 😄
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
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.
This is required for: matrix-org/matrix-react-sdk#7005 (to update the popout button when the permission is added after the initial setup already is done)
The WidgetClientApi emits an event
capabilities_renegotiatedwhen new capabilities were added to the the allowed array.A listener to this event is also the preferred place to handle any reaction a client could have for a widget capability change (like displaying the permissions the widget has).