Class AppServiceBot

Construct an AS bot user which has various helper methods.

Param: client

The client instance configured for the AS bot.

Param: registration

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

Param: memberCache

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

Constructors

constructor

Methods

getClient getJoinedMembers getJoinedRooms getRoomInfo getUserId isRemoteUser

Constructors

constructor

  • new AppServiceBot(client, userId, registration, memberCache): AppServiceBot

  • Parameters

    • client: MatrixClient
    • userId: string
    • registration: AppServiceRegistration
    • memberCache: MembershipCache

    Returns AppServiceBot

Methods

getClient

  • getClient(): MatrixClient

  • Returns MatrixClient

getJoinedMembers

  • getJoinedMembers(roomId): 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.

    Parameters

    • roomId: string

      The room to get a list of joined user IDs in.

    Returns Promise<Record<string, {
        avatar_url?: string;
        display_name?: string;
    }>>

    Resolves to a map of user ID => display_name avatar_url

getJoinedRooms

  • getJoinedRooms(): Promise<string[]>

  • Get a list of joined room IDs for the AS bot.

    Returns Promise<string[]>

    Resolves to a list of room IDs.

getRoomInfo

  • getRoomInfo(roomId, joinedRoom?): Promise<RoomInfo>

  • Parameters

    Returns Promise<RoomInfo>

getUserId

  • getUserId(): string

  • Returns string

isRemoteUser

  • isRemoteUser(userId): boolean

  • Test a userId to determine if it's a user within the exclusive regexes of the bridge.

    Parameters

    • userId: string

    Returns boolean

    True if it is a remote user, false otherwise.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc