Type Aliases

Common type aliases.

signal_bot_framework.aliases.RpcRet

Future values returned from JSON-RPC operations.

alias of Future[Response]

signal_bot_framework.aliases.Name

An individual Signal account’s display name.

signal_bot_framework.aliases.Context

Used to identify the context in which a message was received.

Either (“group”, “<group-id>”), or (“individual”, “<signal-account>”, “<display-name>”)

alias of Union[Tuple[Literal[‘group’], GroupId], Tuple[Literal[‘individual’], Union[AccountNumber, AccountUUID], str]]

signal_bot_framework.aliases.MessageCb

Signature for personality callbacks.

alias of Callable[[SignalBot, Union[Tuple[Literal[‘group’], GroupId], Tuple[Literal[‘individual’], Union[AccountNumber, AccountUUID], str]], DataMessage], Awaitable[bool]]

signal_bot_framework.aliases.CronCb

Signature for personality Cron callbacks.

alias of Callable[[SignalBot], Awaitable[None]]

signal_bot_framework.aliases.CronItem

A cron item definition.

Used for remove_cron() or to identify the callback that triggered an exception in handle_callback_exception().

alias of Tuple[str, Callable[[SignalBot], Awaitable[None]]]

signal_bot_framework.aliases.AnyCb

Any callback definition.

alias of Union[Tuple[Literal[‘message’], Callable[[SignalBot, Union[Tuple[Literal[‘group’], GroupId], Tuple[Literal[‘individual’], Union[AccountNumber, AccountUUID], str]], DataMessage], Awaitable[bool]]], Tuple[Literal[‘prefix’], str, Callable[[SignalBot, Union[Tuple[Literal[‘group’], GroupId], Tuple[Literal[‘individual’], Union[AccountNumber, AccountUUID], str]], DataMessage], Awaitable[bool]]], Tuple[Literal[‘keyword’], Tuple[str, bool], Callable[[SignalBot, Union[Tuple[Literal[‘group’], GroupId], Tuple[Literal[‘individual’], Union[AccountNumber, AccountUUID], str]], DataMessage], Awaitable[bool]]], Tuple[Literal[‘account’], Union[AccountNumber, AccountUUID], Callable[[SignalBot, Union[Tuple[Literal[‘group’], GroupId], Tuple[Literal[‘individual’], Union[AccountNumber, AccountUUID], str]], DataMessage], Awaitable[bool]]], Tuple[Literal[‘cron’], str, Callable[[SignalBot], Awaitable[None]]]]