matrix-js-sdk

    Type Alias RoomStateEventHandlerMap

    type RoomStateEventHandlerMap = {
        "Beacon.new": (event: MatrixEvent, beacon: Beacon) => void;
        "RoomState.BeaconLiveness": (
            state: RoomState,
            hasLiveBeacons: boolean,
        ) => void;
        "RoomState.events": (
            event: MatrixEvent,
            state: RoomState,
            prevEvent: MatrixEvent | null,
        ) => void;
        "RoomState.Marker": (
            event: MatrixEvent,
            setStateOptions?: IMarkerFoundOptions,
        ) => void;
        "RoomState.members": (
            event: MatrixEvent,
            state: RoomState,
            member: RoomMember,
        ) => void;
        "RoomState.newMember": (
            event: MatrixEvent,
            state: RoomState,
            member: RoomMember,
        ) => void;
        "RoomState.update": (state: RoomState) => void;
    }
    Index

    Properties

    Beacon.new RoomState.BeaconLiveness RoomState.events RoomState.Marker RoomState.members RoomState.newMember RoomState.update

    Properties

    "Beacon.new": (event: MatrixEvent, beacon: Beacon) => void
    "RoomState.BeaconLiveness": (state: RoomState, hasLiveBeacons: boolean) => void
    "RoomState.events": (
        event: MatrixEvent,
        state: RoomState,
        prevEvent: MatrixEvent | null,
    ) => void

    Fires whenever the event dictionary in room state is updated. This does not guarantee that any related objects (like RoomMember) have been updated. Use RoomStateEvent.Update for that.

    Type declaration

      • (event: MatrixEvent, state: RoomState, prevEvent: MatrixEvent | null): void

      • Parameters

        • event: MatrixEvent

          The matrix event which caused this event to fire.

        • state: RoomState

          The room state whose RoomState.events dictionary was updated.

        • prevEvent: MatrixEvent | null

          The event being replaced by the new state, if known. Note that this can differ from getPrevContent() on the new state event as this is the store's view of the last state, not the previous state provided by the server.

        Returns void

    matrixClient.on("RoomState.events", function(event, state, prevEvent){
      var newStateEvent = event;
    });
    "RoomState.Marker": (
        event: MatrixEvent,
        setStateOptions?: IMarkerFoundOptions,
    ) => void
    "RoomState.members": (
        event: MatrixEvent,
        state: RoomState,
        member: RoomMember,
    ) => void

    Fires whenever a member in the members dictionary is updated in any way.

    Type declaration

    matrixClient.on("RoomState.members", function(event, state, member){
      var newMembershipState = member.membership;
    });
    "RoomState.newMember": (
        event: MatrixEvent,
        state: RoomState,
        member: RoomMember,
    ) => void

    Fires whenever a member is added to the members dictionary. The RoomMember will not be fully populated yet (e.g. no membership state) but will already be available in the members dictionary.

    Type declaration

      • (event: MatrixEvent, state: RoomState, member: RoomMember): void

      • Parameters

        • event: MatrixEvent

          The matrix event which caused this event to fire.

        • state: RoomState

          The room state whose RoomState.members dictionary was updated with a new entry.

        • member: RoomMember

          The room member that was added.

        Returns void

    matrixClient.on("RoomState.newMember", function(event, state, member){
      // add event listeners on 'member'
    });
    "RoomState.update": (state: RoomState) => void

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR