Skylar Sadlier
45ff930518
- Added examples for every node - Fixed User Settings node requiring a roomId when it's not needed - Fixed the documentation for Upload File node - Get User node had unused config code that has been removed
14 KiB
Examples
These examples showcase what is possible with the node-red-contrib-matrix-chat module for Node-RED.
Build something cool with these nodes? Feel free to submit a pull request to share it!
Prerequisites
- A Matrix account
- Node-RED set up and running
- Installed
node-red-contrib-matrix-chatmodule
How to Use the Examples
To try out any of the examples:
- Copy the JSON contents from the
.jsonfile linked in each example. - In Node-RED, use the menu to import the flow:
- Click the hamburger menu (top right corner).
- Select Import.
- Paste the JSON and click Import.
Index
User Management
- Get or set current user display name
- Set user avatar using URL
- Fetch user info by userId
- Create User with Shared Secret Registration
- Create/Edit Synapse User
- Deactivate User
- Force User to Join Room
Message Handling
- Respond to "ping" with "pong"
- Respond to "html" with an HTML message
- Respond to "image" with an uploaded image
- Respond to "file" with an uploaded file
- Respond to "react" with a reaction
- Remove Messages Containing "delete"
Event Handling
- Sending Typing Events to a Room
- Mark all received events as read
- Fetch event by eventId and roomId
- Paginate the entire history of a given room
- Paginate related events to a given eventId
Room Management
- Set room name and topic
- Accept Room Invites from Specific User
- Leave Room When Someone Says "bye"
- Respond to "newroom" by Creating a New Room and Inviting User
- Respond to "joinroom <room_id_or_alias>" by Joining Mentioned Room
- Kick/Ban User from Room
User Information
- Respond to "users" with Full List of Server Users
- Respond to "whois <user_id>" with Information about the User's Session
- Respond to "rooms <user_id>" with User's Rooms
- Respond to "room_users" with Current Room's Users
Advanced Features
User Management
Create User with Shared Secret Registration
Use this flow to create users on servers with closed registration. You can also use this endpoint to create your first admin user, as it is the same as running the local Python script on the server. This requires your registration secret from your homeserver.yaml Synapse server configuration file.
Instructions:
- Edit the object on the inject node to specify the desired username and password.
- Click the inject button (to the left of the inject node) to create the user.
Note: This only works on Synapse servers.
Create/Edit Synapse User
Allows an administrator to create or modify a user account with a specified msg.userId.
Deactivate User
If you send "deactivate_user @test:example.com", the bot will deactivate the @test:example.com account on the server.
Note:
- This requires the bot to be a server admin.
- WARNING: Accounts that are deleted cannot be restored. If you want to temporarily disable a user, consider modifying the user instead.
Force User to Join Room
If you send "force_join @test:example.com !320j90mf0394f:example.com", the bot will force the user @test:example.com into room !320j90mf0394f:example.com.
Note:
- This requires the bot to be a server admin.
- This only works for rooms on the same server.
Message Handling
Respond to "ping" with "pong"
Use this flow to respond to anyone who says "ping" with "pong" in the same room.
Respond to "html" with an HTML Message
Use this flow to respond to anyone who says "html" with an example HTML message. This shows how easy it is to send HTML content.
Respond to "image" with an Uploaded Image
You will need an image on the machine running Node-RED. In this example, example.png exists inside the Node-RED directory.
Instructions:
- Place the image file (
example.png) in the appropriate directory. - Import the flow and deploy it.
Respond to "file" with an Uploaded File
You will need a file on the machine running Node-RED. In this example, sample.pdf exists inside the Node-RED directory.
Instructions:
- Place the file (
sample.pdf) in the appropriate directory. - Import the flow and deploy it.
Respond to "react" with a Reaction
Gives a 👍 reaction when someone says "react".
Remove Messages Containing "delete"
Any messages containing "delete" will be removed by the client.
Note: The bot needs appropriate permissions to remove messages.
Room Management
Accept Room Invites from Specific User
Automatically accept room invites from a specific user.
Leave Room When Someone Says "bye"
Leaves the room when someone says "bye".
Respond to "newroom" by Creating a New Room and Inviting User
When someone sends "newroom", a new room will be created, and the user who sent the message will be invited. The bot will also send a welcome message into the new room.
Respond to "joinroom <room_id_or_alias>" by Joining Mentioned Room
When someone sends "joinroom <room_id_or_alias>", the bot will join the mentioned room.
Kick/Ban User from Room
- If you say "kick @test:example.com", the bot will kick
@test:example.comfrom the current room. - If you say "ban @test:example.com", the bot will ban
@test:example.comfrom the current room.
Note: This requires the bot to have permissions to kick/ban in the current room.
User Information
Respond to "users" with Full List of Server Users
When someone sends the text "users", they receive an HTML message containing all the current users on the server. If your server has many users, this paginates and sends messages with 25 users per message.
Notes:
- This requires admin privileges.
- If there are many users, the bot may send multiple messages due to message size limits.
Respond to "whois <user_id>" with Information about the User's Session
Lists out the user's session info, including IP address, last seen time, and user agent. Useful for finding out more about a specific user on your server.
Notes:
- This requires admin privileges.
- If the user has many sessions, the message may be too large to send in one piece.
Respond to "rooms <user_id>" with User's Rooms
Responds to "rooms <user_id>" with that user's rooms. If the message is just "rooms", it responds with a list of all rooms the server is participating in.
Notes:
- This requires admin privileges.
- If there are many rooms, the message may be too large to send in one piece.
- This only works for users on the current server.
Respond to "room_users" with Current Room's Users
Lists the users participating in the current room.
Note: If there are many users in the room, the message may be too large to send.
Advanced Features
Use Function Node to Run Any Command
If there isn't a node for something you want to do, you can use a function node to manually execute commands. For example, you can redact events (remove messages).
Instructions:
- Use the function node to write custom commands using the
matrix-js-sdkclient. - Make sure to catch any errors in your function node to prevent Node-RED from crashing.
To view the available functions, check out the client.ts file from matrix-js-sdk.
Sending Typing Events to a Room
You can indicate to a room that the bot is typing and also cancel the typing event. This can be useful for making bots feel more interactive (e.g., show typing while requesting an API endpoint).
Download & Store All Received Files/Images
Downloads received files/images. If the file is encrypted, it will decrypt it for you. The decrypt node downloads the file; otherwise, you need to use an HTTP Request node to download the file.
Instructions:
- You may need to edit the storage directory for this to work.
- By default, files are saved in a
downloadsfolder in the Node-RED directory. - Ensure that Node-RED has permission to write to the specified directory.
Fetch event by eventId and roomId
Fetch an event from Matrix by eventId and roomId
Instructions:
- Change the inject node to contain a proper eventId and roomId (topic)
- Inject the payload and you should see the result contain the event data
Paginate related events to a given eventId
Paginate through the related events to a given eventId. Related events being reactions, thread messages, message modifications, message removals, etc. This outputs once per iterated page.
If you would rather have it output one massive list at the end of pagination use this flow: View Aggregated Flow JSON
Instructions:
- Change the inject node to contain a proper eventId and roomId (topic)
- Inject the payload and you should see the result contain a list of related events for the given eventId
Mark all received events as read
With this flow anytime an event is received by the bot it will mark it as read.
Paginate the entire history of a given room
This flow iterates the entire history of a room (outputting for every page we hit).
Fetch user info by userId
Note this only works for users that the bot shares a room with. It will attempt to fetch the user from local storage first and if not found will query the server for the data.
Get or set current user display name
This flow lets you get or set the displayname for the current user.
Set user avatar using URL
Inject a URL to an image and Node-RED will fetch the contents, upload to matrix, then set the user avatar to the new mxc_url.
This is a good example of how to use the upload file node.
Set room name and topic
Changes the specified room's name and topic to the injected values.
There are a bunch of different settings you can change, this is just an example for these two fields to show how it's done.
This node can also be used to read these values.
