Skip to content

Commit

Permalink
docs - fix #2860
Browse files Browse the repository at this point in the history
  • Loading branch information
gfwilliams committed Jul 3, 2023
1 parent 0662bb4 commit cb2760a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 15 deletions.
18 changes: 5 additions & 13 deletions apps/messages/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions apps/messages/lib.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down Expand Up @@ -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;
Expand Down

0 comments on commit cb2760a

Please sign in to comment.