Browse API 1 documentation
grove.away()
Set or clear the connection-wide away message.
Mango 3.1+View Markdown
Signature
ts
grove.away(message?: string | null): void
Availability
IRC-bound runtimes with presence.set. The change affects the identity across the entire connection, including every channel and query.
Parameters
| Parameter | Required | Description |
|---|---|---|
message |
No | Away explanation. Leading/trailing whitespace is removed. Omitted, null, empty, or whitespace-only input clears away. |
Return value
Returns undefined; no Promise or confirmation payload.
Behavior and errors
Missing presence.set or application/composer/settings scope prevents the operation. The IRC server remains responsible for accepting the request. Do not use a channel-local UI toggle as though this changed only that channel.
Example
js
grove.away('Back after lunch')
// Clear it later:
grove.away()