mautrix.appservice

class mautrix.appservice.AppService

Bases: AppServiceServerMixin

The main AppService container.

__init__(server, domain, as_token, hs_token, bot_localpart, id, loop=None, log=None, verify_ssl=True, tls_cert=None, tls_key=None, query_user=None, query_alias=None, bridge_name=None, state_store=None, aiohttp_params=None, ephemeral_events=False, encryption_events=False, default_ua='mautrix-python/0.21.0b4 aiohttp/3.12.15 Python/3.13.7', default_http_retry_count=0, connection_limit=None)
Parameters:

  • server (str)

  • domain (str)

  • as_token (str)

  • hs_token (str)

  • bot_localpart (str)

  • id (str)

  • loop (AbstractEventLoop | None)

  • log (Logger | str | None)

  • verify_ssl (bool)

  • tls_cert (str | None)

  • tls_key (str | None)

  • query_user (Callable[[Request], Awaitable[Response | None]])

  • query_alias (Callable[[Request], Awaitable[Response | None]])

  • bridge_name (str | None)

  • state_store (ASStateStore)

  • aiohttp_params (dict)

  • ephemeral_events (bool)

  • encryption_events (bool)

  • default_ua (str)

  • default_http_retry_count (int)

  • connection_limit (int | None)

Return type:

None

property http_session: ClientSession
property intent: IntentAPI
async ping_self(txn_id=None)
Parameters:

txn_id (str | None)

Return type:

int

async start(host='127.0.0.1', port=8080)
Parameters:
Return type:

None

async stop()
Return type:

None

server: str
domain: str
id: str
verify_ssl: bool
tls_cert: str | None
tls_key: str | None
as_token: str
hs_token: str
bot_mxid: UserID
default_ua: str
default_http_retry_count: int
bridge_name: str | None
state_store: ASStateStore
transactions: set[str]
query_user: Callable[[UserID], JSON]
query_alias: Callable[[RoomAlias], JSON]
ready: bool
live: bool
loop: asyncio.AbstractEventLoop
log: TraceLogger
app: web.Application
runner: web.AppRunner | None