Ircxd.CommandSpec (ircxd v1.1.0)

Copy Markdown View Source

Protocol-owned metadata for commands sent by Ircxd.Client.

Specifications describe IRC syntax and response hints. They do not grant permission to execute a command and do not promise that a remote server will deliver a response.

Summary

Functions

Classifies a command with its parameters and current client state.

Returns all commands with built-in metadata.

Returns protocol metadata for a command.

Functions

classify(command, params, client_info)

@spec classify(String.t(), [String.t()], Ircxd.Client.Info.t() | map()) :: map()

Classifies a command with its parameters and current client state.

commands()

@spec commands() :: [String.t()]

Returns all commands with built-in metadata.

get(command)

@spec get(String.t()) :: map()

Returns protocol metadata for a command.

The result contains syntax, capability, ISUPPORT, sensitive-parameter, event, and client-state information. Unknown commands return known?: false.