From cb2760a3f191e3b0a0ccb178010291358df6ee33 Mon Sep 17 00:00:00 2001 From: Gordon Williams Date: Mon, 3 Jul 2023 15:54:27 +0100 Subject: [PATCH] docs - fix #2860 --- apps/messages/README.md | 18 +++++------------- apps/messages/lib.js | 4 ++-- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/apps/messages/README.md b/apps/messages/README.md index 83524d7c8..dce2a26c1 100644 --- a/apps/messages/README.md +++ b/apps/messages/README.md @@ -1,6 +1,6 @@ # Messages library -This library handles the passing of messages. It can storess a list of messages +This library handles the passing of messages. It can stores a list of messages and allows them to be retrieved by other apps. ## Example @@ -37,18 +37,10 @@ myMessageListener = Bangle.on("message", (type, message)=>{ }); ``` -Apps can launch the full GUI by calling `require("messages").openGUI()`, if you -want to write your own GUI, it should include boot code that listens for -`"messageGUI"` events: - -```js -Bangle.on("messageGUI", message=>{ - if (message.handled) return; // another app already opened it's GUI - message.handled = true; // prevent other apps form launching - Bangle.load("my_message_gui.app.js"); -}) - -``` +Apps can launch the currently installed Message GUI by calling `require("messages").openGUI()`. +If you want to write your own GUI, it should include a library called `messagegui` +with a method called `open` that will cause it to be opened, with the +optionally supplied message. See `apps/messagegui/lib.js` for an example. ## Requests diff --git a/apps/messages/lib.js b/apps/messages/lib.js index 7a515a1f8..f3ae253e6 100644 --- a/apps/messages/lib.js +++ b/apps/messages/lib.js @@ -107,7 +107,7 @@ exports.dismiss = function(msg) { }; /** - * Emit a "type=openGUI" event, to open GUI app + * Open the Messages GUI app * * @param {object} [msg={}] Message the app should show */ @@ -215,7 +215,7 @@ exports.buzz = function(msgSrc) { let repeat = msgSettings.repeat; if (repeat===undefined) repeat = 4; // repeat may be zero - if (repeat) + if (repeat) { exports.buzzInterval = setInterval(() => require("buzz").pattern(pattern), repeat*1000); let vibrateTimeout = msgSettings.vibrateTimeout;