hcoopmeetbotlogic.interface

Object interface used by plugin to access code in the local package.

Module Contents

class hcoopmeetbotlogic.interface.Context

Context for a message or command, including callbacks that can be invoked.

get_topic

Get the topic for the current context

Type:

Callable[[], str]

set_topic

Set a topic in the correct context

Type:

Callable[[str], None]

send_reply

Send a reply in the current context

Type:

Callable[[str], None]

send_message

Send a message to the server immediately

Type:

Callable[[str], None]

get_topic: Callable[[], str]

set_topic: Callable[[str], None]

send_reply: Callable[[str], None]

send_message: Callable[[str], None]

class hcoopmeetbotlogic.interface.Message

A message to be processed.

id

Identifier for the message

Type:

str

timestamp

Time the message was received

Type:

str

nick

Nickname of the IRC user that sent the message

Type:

str

channel

Channel the message was sent to

Type:

str

network

Network the message was sent on

Type:

str

payload

Message payload

Type:

str

topic

Current topic of the channel

Type:

Optional[str]

channel_nicks

List of nicknames currently in the channel

Type:

Optional[Iterable[str]]

id: str

timestamp: datetime.datetime

nick: str

channel: str

network: str

payload: str

topic: str | None = None

channel_nicks: Iterable[str] | None = None