Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bridge

Hierarchy

  • Bridge

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly opts

opts: VettedBridgeOpts

Accessors

appService

botUserId

  • get botUserId(): string

Methods

addAppServicePath

  • addAppServicePath(opts: { checkToken?: boolean; handler: (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, respose: Response<any, Record<string, any>>, next: NextFunction) => void; method: "POST" | "GET" | "PUT" | "DELETE"; path: string }): void

  • Install a custom handler for an incoming HTTP API request. This allows callers to add extra functionality, implement new APIs, etc...

    Parameters

    • opts: { checkToken?: boolean; handler: (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, respose: Response<any, Record<string, any>>, next: NextFunction) => void; method: "POST" | "GET" | "PUT" | "DELETE"; path: string }

      Named options

      • Optional checkToken?: boolean

        Should the token be automatically checked. Defaults to true.

      • handler: (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, respose: Response<any, Record<string, any>>, next: NextFunction) => void

        Function to handle requests to this endpoint.

          • (req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, respose: Response<any, Record<string, any>>, next: NextFunction): void

          • Parameters

            • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
            • respose: Response<any, Record<string, any>>
            • next: NextFunction

            Returns void

      • method: "POST" | "GET" | "PUT" | "DELETE"

        The HTTP method name.

      • path: string

        Path to the endpoint.

    Returns void

canProvisionRoom

  • Determines whether a room should be provisoned based on user provided rules and the room state. Will default to true if no rules have been provided.

    Parameters

    • roomId: string

      The room to check.

    • cache: boolean = true

      Should the validator check its cache.

    Returns Promise<RoomLinkValidatorStatus>

    resolves if can and rejects if it cannot. A status code is returned on both.

checkHomeserverSupport

  • checkHomeserverSupport(): Promise<void>

close

  • close(): Promise<void>

  • Close the appservice HTTP listener, and clear all timeouts.

    Returns Promise<void>

    Resolves when the appservice HTTP listener has stopped

getAnyASMemberInRoom

  • getAnyASMemberInRoom(roomId: string, preferBot?: boolean): Promise<null | string>

  • Find a member for a given room. This method will fetch the joined members from the homeserver if the cache doesn't have it stored.

    Parameters

    • roomId: string
    • preferBot: boolean = true

      Should we prefer the bot user over a ghost user

    Returns Promise<null | string>

    The userID of the member.

getBot

getClientFactory

  • Retrieve the matrix client factory used when sending matrix requests.

    deprecated

    The client factory is deprecated.

    Returns ClientFactory

getEventStore

getIntent

  • Retrieve an Intent instance for the specified user ID. If no ID is given, an instance for the bot itself is returned.

    Parameters

    • Optional userId: string

      Optional. The user ID to get an Intent for.

    • Optional request: Request<unknown>

      Optional. The request instance to tie the MatrixClient instance to. Useful for logging contextual request IDs.

    Returns Intent

    The intent instance

getIntentFromLocalpart

  • getIntentFromLocalpart(localpart: string, request?: Request<unknown>): Intent

  • Retrieve an Intent instance for the specified user ID localpart. This must be the complete user localpart.

    Parameters

    • localpart: string

      The user ID localpart to get an Intent for.

    • Optional request: Request<unknown>

      Optional. The request instance to tie the MatrixClient instance to. Useful for logging contextual request IDs.

    Returns Intent

    The intent instance

getPrometheusMetrics

  • getPrometheusMetrics(registerEndpoint?: boolean, registry?: Registry): PrometheusMetrics

  • Returns a PrometheusMetrics instance stored on the bridge, creating it first if required. The instance will be registered with the HTTP server so it can serve the "/metrics" page in the usual way. The instance will automatically register the Matrix SDK metrics by calling {PrometheusMetrics~registerMatrixSdkMetrics}.

    Parameters

    • registerEndpoint: boolean = true

      Register the /metrics endpoint on the appservice HTTP server. Defaults to true.

    • Optional registry: Registry

      Optionally provide an alternative registry for metrics.

    Returns PrometheusMetrics

getRequestFactory

getRoomLinkValidator

getRoomStore

getUserStore

initalise

  • initalise(): Promise<void>

  • Load registration, databases and initalise bridge components.

    This must be called before listen()

    Returns Promise<void>

listen

  • listen(port: number, hostname?: string, backlog?: number, appServiceInstance?: AppService): Promise<void>

  • Setup a HTTP listener to handle appservice traffic. ** This must be called after .initalise() **

    Parameters

    • port: number

      The port to listen on.

    • hostname: string = "0.0.0.0"

      Optional hostname to bind to.

    • backlog: number = 10
    • Optional appServiceInstance: AppService

      The AppService instance to attach to. If not provided, one will be created.

    Returns Promise<void>

loadDatabases

  • loadDatabases(): Promise<void>

  • Load the user and room databases. Access them via getUserStore() and getRoomStore().

    Returns Promise<void>

pingAppserviceRoute

  • pingAppserviceRoute(roomId: string, timeoutMs?: number): Promise<number>

  • Check the homeserver -> appservice connection by sending a ping event.

    throws

    This will throw if another ping attempt is made, or if the request times out.

    Parameters

    • roomId: string

      The room to use as a ping check.

    • timeoutMs: number = ...

      How long to wait for the ping attempt. Defaults to 60s.

    Returns Promise<number>

    The delay in milliseconds

provisionUser

  • provisionUser(matrixUser: MatrixUser, provisionedUser?: { name?: string; remote?: RemoteUser; url?: string }): Promise<void>

  • Provision a user on the homeserver.

    Parameters

    • matrixUser: MatrixUser

      The virtual user to be provisioned.

    • Optional provisionedUser: { name?: string; remote?: RemoteUser; url?: string }

      Provisioning information.

      • Optional name?: string
      • Optional remote?: RemoteUser
      • Optional url?: string

    Returns Promise<void>

    Resolved when provisioned.

registerBridgeGauges

  • A convenient shortcut to calling registerBridgeGauges() on the PrometheusMetrics instance directly. This version will supply the value of the matrixGhosts field if the counter function did not return it, for convenience.

    example

    bridge.registerBridgeGauges(() => { return { matrixRoomConfigs: Object.keys(this.matrixRooms).length, remoteRoomConfigs: Object.keys(this.remoteRooms).length,

        remoteGhosts: Object.keys(this.remoteGhosts).length,

    ...
}

    })

    Parameters

    Returns void

requestCheckToken

  • requestCheckToken(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): boolean

  • Check a express Request to see if it's correctly authenticated (includes the hsToken). The query parameter access_token and the Authorization header are checked.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

    Returns boolean

    True if authenticated, False if not.

run

  • run(port: number, appServiceInstance?: AppService, hostname?: string, backlog?: number): Promise<void>

  • Run the bridge (start listening). This calls initalise() and listen().

    Parameters

    • port: number

      The port to listen on.

    • Optional appServiceInstance: AppService

      The AppService instance to attach to. If not provided, one will be created.

    • hostname: string = "0.0.0.0"

      Optional hostname to bind to.

    • backlog: number = 10

    Returns Promise<void>

    A promise resolving when the bridge is ready.

updateRoomLinkValidatorRules

  • updateRoomLinkValidatorRules(rules: Rules): void

Generated using TypeDoc