mautrix.appservice — mautrix-python 0.21.0 documentation (original) (raw)

class mautrix.appservice.AppService

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.0 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:

host (str)
port (int)

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_