Interface BridgeController

interface BridgeController {
    onAliasQueried?: ((alias, roomId) => PossiblePromise<void>);
    onAliasQuery?: ((alias, aliasLocalpart) => PossiblePromise<null | void | {
        creationOpts?: Record<string, unknown>;
        remote?: RemoteRoom;
        roomId?: string;
    }>);
    onEphemeralEvent?: ((request) => void);
    onEvent: ((request, context?) => void);
    onLog?: ((text, isError) => void);
    onUserQuery?: ((matrixUser) => PossiblePromise<null | void | {
        name?: string;
        remote?: RemoteUser;
        url?: string;
    }>);
    thirdPartyLookup?: {
        protocols: string[];
        getLocation?(protocol, fields): PossiblePromise<ThirdpartyLocationResponse[]>;
        getProtocol?(protocol): PossiblePromise<ThirdpartyProtocolResponse>;
        getUser?(protocol, fields): PossiblePromise<ThirdpartyUserResponse[]>;
        parseLocation?(alias): PossiblePromise<ThirdpartyLocationResponse[]>;
        parseUser?(userid): PossiblePromise<ThirdpartyLocationResponse[]>;
    };
    userActivityTracker?: UserActivityTracker;
}

Properties

onAliasQueried? onAliasQuery? onEphemeralEvent? onEvent onLog? onUserQuery? thirdPartyLookup? userActivityTracker?

Properties

Optional onAliasQueried

onAliasQueried?: ((alias, roomId) => PossiblePromise<void>)

The bridge will invoke this function when a room has been created via onAliasQuery.

Type declaration

    • (alias, roomId): PossiblePromise<void>

    • The bridge will invoke this function when a room has been created via onAliasQuery.

      Parameters

      • alias: string
      • roomId: string

      Returns PossiblePromise<void>

Optional onAliasQuery

onAliasQuery?: ((alias, aliasLocalpart) => PossiblePromise<null | void | {
    creationOpts?: Record<string, unknown>;
    remote?: RemoteRoom;
    roomId?: string;
}>)

The bridge will invoke this function when queried via onAliasQuery. If not supplied, no rooms will be provisioned on alias queries. Provisioned rooms will automatically be stored in the associated roomStore.

Type declaration

    • (alias, aliasLocalpart): PossiblePromise<null | void | {
          creationOpts?: Record<string, unknown>;
          remote?: RemoteRoom;
          roomId?: string;
      }>

    • The bridge will invoke this function when queried via onAliasQuery. If not supplied, no rooms will be provisioned on alias queries. Provisioned rooms will automatically be stored in the associated roomStore.

      Parameters

      • alias: string
      • aliasLocalpart: string

      Returns PossiblePromise<null | void | {
          creationOpts?: Record<string, unknown>;
          remote?: RemoteRoom;
          roomId?: string;
      }>

Optional onEphemeralEvent

onEphemeralEvent?: ((request) => void)

The bridge will invoke this when a typing, read reciept or presence event is received from the HS. This will only work with the bridgeEncryption configuration set.

Type declaration

    • (request): void

    • The bridge will invoke this when a typing, read reciept or presence event is received from the HS. This will only work with the bridgeEncryption configuration set.

      Parameters

      Returns void

onEvent

onEvent: ((request, context?) => void)

The bridge will invoke when an event has been received from the HS.

Type declaration

    • (request, context?): void

    • The bridge will invoke when an event has been received from the HS.

      Parameters

      Returns void

Optional onLog

onLog?: ((text, isError) => void)

Invoked when logging. Defaults to a function which logs to the console.

Type declaration

    • (text, isError): void

    • Invoked when logging. Defaults to a function which logs to the console.

      Parameters

      • text: string
      • isError: boolean

      Returns void

Optional onUserQuery

onUserQuery?: ((matrixUser) => PossiblePromise<null | void | {
    name?: string;
    remote?: RemoteUser;
    url?: string;
}>)

The bridge will invoke this function when queried via onUserQuery. If not supplied, no users will be provisioned on user queries. Provisioned users will automatically be stored in the associated userStore.

Type declaration

    • (matrixUser): PossiblePromise<null | void | {
          name?: string;
          remote?: RemoteUser;
          url?: string;
      }>

    • The bridge will invoke this function when queried via onUserQuery. If not supplied, no users will be provisioned on user queries. Provisioned users will automatically be stored in the associated userStore.

      Parameters

      Returns PossiblePromise<null | void | {
          name?: string;
          remote?: RemoteUser;
          url?: string;
      }>

Optional thirdPartyLookup

thirdPartyLookup?: {
    protocols: string[];
    getLocation?(protocol, fields): PossiblePromise<ThirdpartyLocationResponse[]>;
    getProtocol?(protocol): PossiblePromise<ThirdpartyProtocolResponse>;
    getUser?(protocol, fields): PossiblePromise<ThirdpartyUserResponse[]>;
    parseLocation?(alias): PossiblePromise<ThirdpartyLocationResponse[]>;
    parseUser?(userid): PossiblePromise<ThirdpartyLocationResponse[]>;
}

If supplied, the bridge will respond to third-party entity lookups using the contained helper functions.

Type declaration

  • protocols: string[]
  • getLocation?:function
    • getLocation(protocol, fields): PossiblePromise<ThirdpartyLocationResponse[]>

    • Parameters

      • protocol: string
      • fields: Record<string, string | string[]>

      Returns PossiblePromise<ThirdpartyLocationResponse[]>

  • getProtocol?:function
    • getProtocol(protocol): PossiblePromise<ThirdpartyProtocolResponse>

    • Parameters

      • protocol: string

      Returns PossiblePromise<ThirdpartyProtocolResponse>

  • getUser?:function
    • getUser(protocol, fields): PossiblePromise<ThirdpartyUserResponse[]>

    • Parameters

      • protocol: string
      • fields: Record<string, string | string[]>

      Returns PossiblePromise<ThirdpartyUserResponse[]>

  • parseLocation?:function
    • parseLocation(alias): PossiblePromise<ThirdpartyLocationResponse[]>

    • Parameters

      • alias: string

      Returns PossiblePromise<ThirdpartyLocationResponse[]>

  • parseUser?:function
    • parseUser(userid): PossiblePromise<ThirdpartyLocationResponse[]>

    • Parameters

      • userid: string

      Returns PossiblePromise<ThirdpartyLocationResponse[]>

Optional userActivityTracker

userActivityTracker?: UserActivityTracker

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc