Documentation
Tutorials
Appservice (bridge) usage Bot usage Encryption Room upgrades

Class

AppserviceApis

AppserviceApis(client, appserviceId)

APIs for use within the scope of an appservice.
Constructor

# new AppserviceApis(client, appserviceId)

Parameters:
Name Type Description
client A client with the appservice token configured.
appserviceId The `id` of the appservice, as per its registration file.

View Source AppserviceApis.ts, line 5

Classes

AppserviceApis
AppserviceApis

Methods

# pingHomeserver(transactionId) → {Promise.<PingHomeserverResponse>}

This API asks the homeserver to call the /_matrix/app/v1/ping endpoint on the application service to ensure that the homeserver can communicate with the application service.
Parameters:
Name Type Description
transactionId A unique ID that identifies the ping request.

View Source AppserviceApis.ts, line 49

Promise.<PingHomeserverResponse>