Documentation LOG API
Tutorials
My Awesome Tutorial Swagger Setup on Express API What is JSDoc? TypeScript vs JSDoc

Class

MatrixBridge

MatrixBridge()

Utility class for common operations performed by bridges (represented as appservices).

The storage utilities are not intended for bridges which allow 1:many relationships with the remote network.

Bridges are generally expected to create their own classes which extend the IRemoteRoomInfo and IRemoteUserInfo interfaces and serialize to JSON cleanly. The serialized version of these classes is persisted in various account data locations for future lookups.

Constructor

# new MatrixBridge()

View Source fixtures/typescript/class.ts, line 15

Methods

# async getRemoteRoomInfo(matrixRoomId) → {Promise.<IRemoteRoomInfo>}

Gets information about a remote room.

Parameters:
Name Type Description
matrixRoomId string

The Matrix room ID to get information on.

View Source fixtures/typescript/class.ts, line 57

Resolves to the remote room information.

Promise.<IRemoteRoomInfo>

# async getRemoteUserInfo(userIntent) → {Promise.<IRemoteUserInfo>}

Gets information about a remote user.

Parameters:
Name Type Description
userIntent Intent

The Matrix user intent to get information on.

View Source fixtures/typescript/class.ts, line 48

Resolves to the remote user information.

Promise.<IRemoteUserInfo>

MatrixBridge()

Utility class for common operations performed by bridges (represented as appservices).

The storage utilities are not intended for bridges which allow 1:many relationships with the remote network.

Bridges are generally expected to create their own classes which extend the IRemoteRoomInfo and IRemoteUserInfo interfaces and serialize to JSON cleanly. The serialized version of these classes is persisted in various account data locations for future lookups.

Constructor

# new MatrixBridge()

View Source fixtures/typescript/class.ts, line 15

Methods

# async getRemoteRoomInfo(matrixRoomId) → {Promise.<IRemoteRoomInfo>}

Gets information about a remote room.

Parameters:
Name Type Description
matrixRoomId string

The Matrix room ID to get information on.

View Source fixtures/typescript/class.ts, line 57

Resolves to the remote room information.

Promise.<IRemoteRoomInfo>

# async getRemoteUserInfo(userIntent) → {Promise.<IRemoteUserInfo>}

Gets information about a remote user.

Parameters:
Name Type Description
userIntent Intent

The Matrix user intent to get information on.

View Source fixtures/typescript/class.ts, line 48

Resolves to the remote user information.

Promise.<IRemoteUserInfo>