Class: AppServiceBot

AppServiceBot

new AppServiceBot(client, registration)

Construct an AS bot user which has various helper methods.
Parameters:
Name Type Description
client MatrixClient The client instance configured for the AS bot.
registration AppServiceRegistration The registration that the bot is following. Used to determine which user IDs it is controlling.
Source:

Methods

getMemberLists() → {Promise}

Get the membership lists of every room the AS bot is in. This does an initial sync.
Source:
Returns:
Resolves to a dict of room_id: AppServiceBot~RoomInfo.
Type
Promise

Type Definitions

RoomInfo

Type:
  • Object
Properties:
Name Type Description
id string The matrix room ID
state Array.<Object> The raw state events for this room
realJoinedUsers Array.<string> A list of user IDs of real matrix users that have joined this room.
remoteJoinedUsers Array.<string> A list of user IDs of remote users (provisioned by the AS) that have joined this room.
Source: