UnrealIRCd User ToolInstall

Summary

Make a specific IRC user join one or more channels, optionally providing channel keys and forcing join even if restrictions apply.

Inputs

• Nick (required) — The nickname or UID of the IRC user to target.
• Channel (required) — The IRC channel name(s) to join, which can be a comma-separated list (e.g., '#general' or '#chan1,#chan2').
• Key — The channel key/password if the channel requires one.
• Force Join/Part — Boolean to bypass channel join restrictions (like SAJOIN) or to show force notification (SAPART).
• Redaction Options — Options to redact sensitive information from the operation response, including IP addresses, emails, passwords, and custom patterns.

Output shape

a single record containing the success status and result details of the join operation for the specified user and channels.

The output JSON includes 'operation' (string), 'success' (boolean), and 'result' (varies). Responses may have sensitive data redacted based on redaction settings. Errors can be captured if 'continueOnFail' is enabled.