Interface Connection.Interface.IRCCommand1

Interface Index (Compact) | Summary | Description | Methods

Methods

Send (s: Command) nothing
WARNING: This interface is not well-tested and is likely to cause havoc to your API/ABI if bindings are generated. Do not include this interface in libraries that care about compatibility.
Added in 0.27.3.
Objects implementing this interface must also implement:

Description

An interface to send arbitrary IRC commands to the server.

Methods

(Permalink)

Send (s: Command) → nothing

Parameters

  • Command — s
  • The command followed by its arguments.

Send an arbitrary IRC command to the server.

For example, an IRC client receiving /bip blreset from the user might call this method with BIP blreset as argument which will send BIP blreset to the server.

The command is supplied in UTF-8 (because strings on D-Bus are always UTF-8). It is transcoded into the connection's configured character set, if different, before sending to the server.


Possible Errors

  • Disconnected
  • The connection is not currently connected and cannot be used. This error may also be raised when operations are performed on a Connection for which StatusChanged has signalled status Disconnected for reason None.
    Rationale:
    The second usage corresponds to None in the Connection_Status_Reason enum; if a better reason is available, the corresponding error should be used instead.
  • Network Error
  • Raised when there is an error reading from or writing to the network.
  • Invalid Argument
  • The connection manager MAY raise this error for commands that have a more appropriate D-Bus API.