matridge.command

Classes

ListSpaces	Abstract base class to implement gateway commands (chatbot and ad-hoc)
ManageTrust	Abstract base class to implement gateway commands (chatbot and ad-hoc)

Module Contents

class matridge.command.ListSpaces(xmpp)

Bases: slidge.command.Command

Abstract base class to implement gateway commands (chatbot and ad-hoc)

Parameters:

xmpp (slidge.core.gateway.BaseGateway)

NAME = '🌌 Matrix spaces'

Friendly name of the command, eg: “do something with stuff”

CATEGORY

If used, the command will be under this top-level category. Use the same string for several commands to group them. This hierarchy only used for the adhoc interface, not the chat command interface.

HELP = "List the matrix spaces you're part of"

Long description of what the command does

ACCESS

Who can use this command

async run(session, _ifrom, *args)

Entry point of the command

Parameters:

• session (matridge.session.Session) – If triggered by a registered user, its slidge Session

• ifrom – JID of the command-triggering entity

• args (str) – When triggered via chatbot type message, additional words after the CHAT_COMMAND string was passed

Returns:

Either a TableResult, a Form, a Confirmation, a text, or None

Return type:

slidge.command.Form

static finish(form_values, session, _ifrom, rooms)

Async:

Parameters:

• form_values (slidge.command.base.FormValues)

• session (matridge.session.Session)

• rooms (list[nio.MatrixRoom])

class matridge.command.ManageTrust(xmpp)

Bases: slidge.command.Command

Abstract base class to implement gateway commands (chatbot and ad-hoc)

Parameters:

xmpp (slidge.core.gateway.BaseGateway)

NAME = '🤝 Manage trust in devices'

Friendly name of the command, eg: “do something with stuff”

CATEGORY

If used, the command will be under this top-level category. Use the same string for several commands to group them. This hierarchy only used for the adhoc interface, not the chat command interface.

HELP = 'Manage which OLM keys you trust or not.'

Long description of what the command does

ACCESS

Who can use this command

HUMAN_STATES

__human_device(d, state=True)

Parameters:

d (nio.crypto.OlmDevice)

async run(session, _ifrom, *args)

Entry point of the command

Parameters:

• session (matridge.session.Session) – If triggered by a registered user, its slidge Session

• ifrom – JID of the command-triggering entity

• args (str) – When triggered via chatbot type message, additional words after the CHAT_COMMAND string was passed

Returns:

Either a TableResult, a Form, a Confirmation, a text, or None

Return type:

Union[slidge.command.Form, str]

async step2(form_values, session, _ifrom, devices)

Parameters:

• form_values (slidge.command.base.FormValues)

• session (matridge.session.Session)

• devices (dict[str, nio.crypto.OlmDevice])