Igor

v0.3.0

Igor v0.3.0 Igor.Responder.Help.Proto protocol View Source

Link to this section Summary

Types

t()

Functions

help(responder, cmdprefix)

Get the general help for the responder.

help(responder, cmdprefix, command)

Get the help text for a specific command.

Link to this section Types

Link to this type

t()

View Source 
t() :: term()

Link to this section Functions

Link to this function

help(responder, cmdprefix)

View Source 
help(responder :: t(), cmdprefix :: String.t()) :: [
  Polyjuice.Client.MsgBuilder.MsgData.t()
]

Get the general help for the responder.

A prefix will be passed; commands should be prefixed by the given prefix in the help text. It should return an array of items that implement the Polyjuice.Client.MsgBuilder.MsgData protocol; each item will be a separate line in the output for the help command.

Link to this function

help(responder, cmdprefix, command)

View Source 
help(responder :: t(), cmdprefix :: String.t(), command :: list()) ::
  Polyjuice.Client.MsgBuilder.MsgData.t() | nil

Get the help text for a specific command.

A prefix will be passed; the command should be prefixed by the given prefix in the help text. If the responder implements the given command, it should return detailed help for the command. Otherwise, it should return nil. The command may have multiple components, and so is given as a list.