Class AppServiceBot

Construct an AS bot user which has various helper methods.

Param

The client instance configured for the AS bot.

Param

The registration that the bot is following. Used to determine which user IDs it is controlling.

Param

The bridges membership cache instance, for storing membership the bot has discovered.

Hierarchy

AppServiceBot

Index

Constructors

Methods

getClient getJoinedMembers getJoinedRooms getRoomInfo getUserId isRemoteUser

Constructors

constructor

new AppServiceBot(client: MatrixClient, userId: string, registration: AppServiceRegistration, memberCache: MembershipCache): AppServiceBot
Parameters
- client: MatrixClient
- userId: string
- registration: AppServiceRegistration
- memberCache: MembershipCache
Returns AppServiceBot

Methods

getClient

getClient(): MatrixClient
Returns MatrixClient

getJoinedMembers

getJoinedMembers(roomId: string): Promise<Record<string, { avatar_url?: string; display_name?: string }>>
Get a map of joined user IDs for the given room ID. The values in the map are objects with a 'display_name' and 'avatar_url' properties. These properties may be null.

Returns
Resolves to a map of user ID => display_name avatar_url
Parameters
- roomId: string
  
  The room to get a list of joined user IDs in.
Returns Promise<Record<string, { avatar_url?: string; display_name?: string }>>

getJoinedRooms

getJoinedRooms(): Promise<string[]>
Get a list of joined room IDs for the AS bot.

Returns
Resolves to a list of room IDs.

Returns Promise<string[]>

getRoomInfo

getRoomInfo(roomId: string, joinedRoom?: { state?: { events: StateLookupEvent[] } }): Promise<RoomInfo>
Parameters
- roomId: string
- joinedRoom: { state?: { events: StateLookupEvent[] } } = {}
  - Optional state?: { events: StateLookupEvent[] }
    - events: StateLookupEvent[]
Returns Promise<RoomInfo>

getUserId

getUserId(): string
Returns string

isRemoteUser

isRemoteUser(userId: string): boolean
Test a userId to determine if it's a user within the exclusive regexes of the bridge.

Returns
True if it is a remote user, false otherwise.
Parameters
- userId: string
Returns boolean

Generated using TypeDoc