matrix-js-sdk

    Type Alias UserEventHandlerMap

    type UserEventHandlerMap = {
        "User.avatarUrl": (event: MatrixEvent | undefined, user: User) => void;
        "User.currentlyActive": (
            event: MatrixEvent | undefined,
            user: User,
        ) => void;
        "User.displayName": (event: MatrixEvent | undefined, user: User) => void;
        "User.lastPresenceTs": (event: MatrixEvent | undefined, user: User) => void;
        "User.presence": (event: MatrixEvent | undefined, user: User) => void;
    }
    Index

    Properties

    User.avatarUrl User.currentlyActive User.displayName User.lastPresenceTs User.presence

    Properties

    "User.avatarUrl": (event: MatrixEvent | undefined, user: User) => void

    Fires whenever any user's avatar URL changes.

    Type declaration

      • (event: MatrixEvent | undefined, user: User): void

      • Parameters

        • event: MatrixEvent | undefined

          The matrix event which caused this event to fire.

        • user: User

          The user whose User.avatarUrl changed.

        Returns void

    matrixClient.on("User.avatarUrl", function(event, user){
      var newUrl = user.avatarUrl;
    });
    "User.currentlyActive": (event: MatrixEvent | undefined, user: User) => void

    Fires whenever any user's currentlyActive changes.

    Type declaration

      • (event: MatrixEvent | undefined, user: User): void

      • Parameters

        • event: MatrixEvent | undefined

          The matrix event which caused this event to fire.

        • user: User

          The user whose User.currentlyActive changed.

        Returns void

    matrixClient.on("User.currentlyActive", function(event, user){
      var newCurrentlyActive = user.currentlyActive;
    });
    "User.displayName": (event: MatrixEvent | undefined, user: User) => void

    Fires whenever any user's display name changes.

    Type declaration

      • (event: MatrixEvent | undefined, user: User): void

      • Parameters

        • event: MatrixEvent | undefined

          The matrix event which caused this event to fire.

        • user: User

          The user whose User.displayName changed.

        Returns void

    matrixClient.on("User.displayName", function(event, user){
      var newName = user.displayName;
    });
    "User.lastPresenceTs": (event: MatrixEvent | undefined, user: User) => void

    Fires whenever any user's lastPresenceTs changes, ie. whenever any presence event is received for a user.

    Type declaration

      • (event: MatrixEvent | undefined, user: User): void

      • Parameters

        • event: MatrixEvent | undefined

          The matrix event which caused this event to fire.

        • user: User

          The user whose User.lastPresenceTs changed.

        Returns void

    matrixClient.on("User.lastPresenceTs", function(event, user){
      var newlastPresenceTs = user.lastPresenceTs;
    });
    "User.presence": (event: MatrixEvent | undefined, user: User) => void

    Fires whenever any user's presence changes.

    Type declaration

      • (event: MatrixEvent | undefined, user: User): void

      • Parameters

        • event: MatrixEvent | undefined

          The matrix event which caused this event to fire.

        • user: User

          The user whose User.presence changed.

        Returns void

    matrixClient.on("User.presence", function(event, user){
      var newPresence = user.presence;
    });

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR