Matrix/node-red-contrib-matrix-chat-jw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update examples to move function example above verification ones.

Browse Source
This commit is contained in:
Skylar Sadlier 2022-03-17 19:54:13 -06:00
parent 68cb5a026e
commit 487f17a439
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
examples/README.md
View File

@ -51,6 +51,19 @@ Allows an administrator to create or modify a user account with a specified `msg
![add-user-with-admin-user.png](add-user-with-admin-user.png)
### Use function node to run any command
[View JSON](custom-redact-function-node.json)
If we do not have a node for something you want to do you can do this manually with a function node. We now have a node for removing events but this is still a good example.
**Note:** You should make sure to catch any errors in your function node otherwise you could cause Node-RED to crash.
To view what sort of functions you have access to check out the `client.ts` file from `matrix-js-sdk` [here](https://github.com/matrix-org/matrix-js-sdk/blob/master/src/client.ts).
![custom-redact-function-node.png](custom-redact-function-node.png)
### Request device verification & immediately accept
[View JSON](request-device-verification.json)
@ -70,19 +83,6 @@ After verification starts the bot automatically accepts the result (note: you sh
![add-user-with-admin-user.png](start-accept-verification-from-user.png)
### Use function node to run any command
[View JSON](custom-redact-function-node.json)
If we do not have a node for something you want to do (such as redacting events/messages) you can do this manually with a function node.
**Note:** You should make sure to catch any errors in your function node otherwise you could cause Node-RED to crash.
To view what sort of functions you have access to check out the `client.ts` file from `matrix-js-sdk` [here](https://github.com/matrix-org/matrix-js-sdk/blob/master/src/client.ts).
![custom-redact-function-node.png](custom-redact-function-node.png)
### Respond to "ping" with "pong"
[View JSON](respond-ping-pong.json)