Class: BridgeContext

BridgeContext(ctx)

Bridge context.

Constructor

new BridgeContext(ctx)

Parameters:
Name Type Description
ctx Object Event related data
Properties
Name Type Attributes Description
sender string Matrix user ID of the sender.
target string <optional>
Matrix user ID of the target.
room string Matrix room ID.
Properties:
Name Type Description
senders Object Data models on senders of this event
Properties
Name Type Attributes Description
matrix MatrixUser The sender of this event
remote RemoteUser <nullable>
The first linked remote sender: remotes[0]
remotes Array.<RemoteUser> The linked remote senders
targets Object Data models on targets (e.g. state_key in m.room.member) of this event.
Properties
Name Type Attributes Description
matrix MatrixUser <nullable>
The target of this event if applicable.
remote RemoteUser <nullable>
The first linked remote target: remotes[0]
remotes Array.<RemoteUser> The linked remote targets
rooms Object Data models on rooms concerning this event.
Properties
Name Type Attributes Description
matrix MatrixRoom The room for this event.
remote RemoteRoom <nullable>
The first linked remote room: remotes[0]
remotes Array.<RemoteRoom> The linked remote rooms for this event
Source:

Methods

(async) get(roomStore, userStore) → {Promise.<BridgeContext>}

Returns this instance after its initialization.
Parameters:
Name Type Description
roomStore RoomBridgeStore
userStore UserBridgeStore
Source:
Returns:
Type
Promise.<BridgeContext>